You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Feb 22, 2020. It is now read-only.
When docs are built (e.g. with make html run from docs directory), the prediction and interface projects should have their docstrings converted to entries in the documentation.
Technical details
Add one code.rst document that has its contents derived automatically from docstrings — don't worry about breaking this up into smaller files yet
Add the new document to the main toctree (table of contents) in index.rst
Important note: this project's chosen convention is to use Google-style docstrings rather than Sphinx style
Out of scope
You don't need to add to or fix existing docstrings as long as there is at least one that shows the autodoc is working.
Acceptance criteria
Docs build correctly with make html run from docs directory
Syntactically correct Google-style docstrings in prediction and interface pieces of the project can get built using autodoc when the appropriate entry is put into code.rst
At least one autodoc entry in code.rst demonstrates this is working
NOTE: All PRs must follow the standard PR checklist.
The text was updated successfully, but these errors were encountered:
Overview
When docs are built (e.g. with
make html
run fromdocs
directory), the prediction and interface projects should have their docstrings converted to entries in the documentation.Technical details
code.rst
document that has its contents derived automatically from docstrings — don't worry about breaking this up into smaller files yettoctree
(table of contents) inindex.rst
Out of scope
You don't need to add to or fix existing docstrings as long as there is at least one that shows the autodoc is working.
Acceptance criteria
make html
run fromdocs
directoryprediction
andinterface
pieces of the project can get built using autodoc when the appropriate entry is put intocode.rst
code.rst
demonstrates this is workingNOTE: All PRs must follow the standard PR checklist.
The text was updated successfully, but these errors were encountered: