Skip to content
This repository has been archived by the owner on Feb 22, 2020. It is now read-only.

Set up Sphinx autodoc for prediction and interface code #8

Closed
3 tasks
isms opened this issue Aug 2, 2017 · 0 comments
Closed
3 tasks

Set up Sphinx autodoc for prediction and interface code #8

isms opened this issue Aug 2, 2017 · 0 comments

Comments

@isms
Copy link
Contributor

isms commented Aug 2, 2017

Overview

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants