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

Documentation using Sphinx #2

Open

jacobnzw opened this issue Mar 28, 2018 · 0 comments

Owner

jacobnzw commented Mar 28, 2018

Generate documentation using Sphinx in PyCharm.

Use NumPy style docstrings. Sphinx converts them to reStructuredText using the napoleon extension (which handles NumPy and Google docstrings).

Do this in a separate branch, because I still don't know what the Sphinx quickstart utility will do to the directory structure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment