Welcome to pyEPR documentation:beers:!

Find the docs at Read the Docs

BUILDING THE DOCS

This folder contains the src and resulting doc files. We use sphinx.

Setup

Install the theme

  pip install sphinx-rtd-theme

First time docs developers

First time setting up Sphinx

Notes for developers.

1. Check out this tut for quicksetup of sphinx

   conda install sphinx numpydoc
   (or pip install -U Sphinx)

2. Install read the docs theme and set in the config html_theme = "sphinx_rtd_theme"

  pip install sphinx_rtd_theme

3. Set up autodoc tut and create full module doc. In the docs directory

  sphinx-apidoc -f -o source/ ../pyEPR -o source/api --no-toc -M -e
  make html

You can also use this to update the doc tree.

Updating readthedocs.org

The docs get update automatically each time you make a commit to the master branch. To check on the status of the docs build or failing, navigate to https://readthedocs.org/projects/pyepr-docs/builds/ and select the latest build to see its progress and report.

To manually initiate a rebuild: Navigate to https://readthedocs.org/projects/pyepr-docs/. Here, if you have write access you can initiate a build.