Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use mkdocstrings for documenting Python code #94

Open
Archmonger opened this issue Aug 18, 2022 · 0 comments
Open

Use mkdocstrings for documenting Python code #94

Archmonger opened this issue Aug 18, 2022 · 0 comments
Labels
complexity: 3 (low) priority: 3 (low) type: docs

Comments

@Archmonger
Copy link
Contributor

Archmonger commented Aug 18, 2022 •
edited
Loading

Current Situation

Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.

Proposed Actions

Use mkdocstrings within the docs to automatically generate markdown based on Python code, type hints, and docstrings.

Implementing this is currently blocked by these issues:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
complexity: 3 (low) priority: 3 (low) type: docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Archmonger