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.

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

Add how to use apidoc guide/doc to our user docs #7162

Open
agjohnson opened this issue Jun 5, 2020 · 1 comment
Open

Add how to use apidoc guide/doc to our user docs #7162

agjohnson opened this issue Jun 5, 2020 · 1 comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Needed: documentation Documentation is required

Comments

@agjohnson
Copy link
Contributor

There are a number of different hacks for getting autoapi command to work on RTD, but there is now a sphinxcontrib extension that does it for users:
https://github.com/sphinx-contrib/apidoc

This would be good for us to highlight, so that users aren't trying to do this themselves or wondering why apidoc command can't execute.

A few things to touch on:

  • Why apidoc command isn't used by RTD
  • How to use the apidoc extension in a project
@agjohnson agjohnson added this to the Better user documentation milestone Jun 5, 2020
@stsewd stsewd added Improvement Minor improvement to code Needed: documentation Documentation is required labels Jun 9, 2020
@stale
Copy link

stale bot commented Jul 25, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jul 25, 2020
@humitos humitos added Accepted Accepted issue on our roadmap and removed Status: stale Issue will be considered inactive soon labels Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants