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

[DOC] Use sphinx-autoapi to automatically generate API reference #44

Open
synchon opened this issue Sep 12, 2022 · 0 comments
Open

[DOC] Use sphinx-autoapi to automatically generate API reference #44

synchon opened this issue Sep 12, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
0.1.0 (release)

Comments

@synchon
Copy link
Member

synchon commented Sep 12, 2022

Which element of the documentation do you want to modify and why?

We use https://sphinx-autoapi.readthedocs.io/en/latest/ to auto-generate API reference instead of using Sphinx's autodoc which requires manual code import directives.

Anything else to say?

No response
@synchon synchon added documentation Improvements or additions to documentation triage New issues waiting to be reviewed labels Sep 12, 2022
@synchon synchon added this to the 0.0.1 milestone Sep 12, 2022
@synchon synchon assigned fraimondo and synchon and unassigned fraimondo and synchon Sep 12, 2022
@synchon synchon removed the triage New issues waiting to be reviewed label Oct 24, 2022
@synchon synchon modified the milestones: 0.0.1, 0.0.2 Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.1.0 (release)
Development

No branches or pull requests
2 participants
@fraimondo @synchon