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

Autogenerate sphinx autodoc docs on Master #2974

Open
innovate-invent opened this issue May 17, 2018 · 4 comments
Open

Autogenerate sphinx autodoc docs on Master #2974

innovate-invent opened this issue May 17, 2018 · 4 comments
Labels
discussion An issue requiring discussion

Comments

@innovate-invent
Copy link

Feature request

Numba needs better code documentation and I feel a good way to motivate contributions is to maintain current Sphinx docs that are accessible via the website.
Travis-CI supports autogeneration of the docs: https://github.com/Syntaf/travis-sphinx

@seibert
Copy link
Contributor

seibert commented May 17, 2018

These docs are (usually) automatically updated whenever there is a merge to master:

http://numba.pydata.org/numba-doc/dev/index.html

It's done with a crude cronjob, so I am interested in moving that to Travis-CI at some point.

@innovate-invent
Copy link
Author

Ah sorry, I meant something along the lines of autodoc generated content.

@innovate-invent innovate-invent changed the title Autogenerate sphinx docs on Master Autogenerate sphinx autodoc docs on Master May 17, 2018
@innovate-invent
Copy link
Author

innovate-invent commented May 17, 2018

Edit: There are a number of options for the docstring format. I am used to restructuredtext but it seems Google has produced a cleaner format. Sphinx was given support for it via http://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html

It also provides a format produced by NumPy, it might be worth considering given Numbas close relationship to the project.

@innovate-invent
Copy link
Author

#2977 Was created to establish the convention.

@stuartarchibald stuartarchibald added the discussion An issue requiring discussion label May 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion An issue requiring discussion
Projects
None yet
Development

No branches or pull requests

3 participants