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 sphinxcontrib apidoc for autogenerated API docs #53

Open
djhoese opened this issue Feb 25, 2022 · 2 comments · May be fixed by #116
Open

Use sphinxcontrib apidoc for autogenerated API docs #53

djhoese opened this issue Feb 25, 2022 · 2 comments · May be fixed by #116
Labels
documentation

Comments

@djhoese
Copy link

djhoese commented Feb 25, 2022

I've had a lot of luck using sphinxcontrib-apidoc to automatically generate the API .rst files when the sphinx documentation is rendered and it has saved me a lot of time. I don't know if any other pangeo projects use it, but I'd be willing to add it here if no one has a problem with that.
@maxrjones
Copy link
Member

Hi @djhoese, sorry that this issue went without a response for so long! Documentation improvements are always appreciated - if you still think this would save time you are welcome to open a PR.

@djhoese
Copy link
Author

djhoese commented Oct 18, 2022

Yeah, I think this tool is always pretty helpful. Given my involvement with the Pangeo ML/NASA project I should be able to find time this week to tackle this. I'll add it to my TODO list. Thanks for responding to old issues!

@djhoese djhoese linked a pull request Oct 23, 2022 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add sphinxcontrib-apidoc for automatic API docs djhoese/xbatcher
2 participants
@djhoese @maxrjones