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

Generate API spec page #1999

Closed
chrysle opened this issue Oct 11, 2023 · 0 comments · Fixed by #2060
Closed

Generate API spec page #1999

chrysle opened this issue Oct 11, 2023 · 0 comments · Fixed by #2060
Labels
docs Documentation related

Comments

@chrysle
Copy link
Contributor

chrysle commented Oct 11, 2023 •
edited
Loading

We should start doing that, then. I usually integrate sphinxcontrib-apidoc for automatic generation like this: cherrypy/cheroot@cb9d3f4. Later on, I remembered to mark the ToC section as private: https://cheroot.cherrypy.dev/en/latest/pkg/modules/.

Originally posted by @webknjaz in #1981 (comment)

I'll have a look at this, thanks for the hints!
@chrysle chrysle added the docs Documentation related label Oct 11, 2023
@chrysle chrysle mentioned this issue Feb 24, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation related
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add private API documentation chrysle/pip-tools
1 participant
@chrysle