Building documentation

Procedure for building documentation for a new release. The precise commands given are examples - tailor to your needs.

• Check out the release tag (e.g., git checkout 0.9.0); make sure your repository is clean (git clean -ffxd)
  • git checkout 0.9.0
  • git clean -ffxd
• Create a new venv for the doc build
  • python -m venv encore-docs && source encore-docs/bin/activate
  • python -m pip install --upgrade pip
• Install necessary packages:
  • python -m pip install Sphinx sphinx_copybutton enthought_sphinx_theme
• Install Encore itself:
  • python -m pip install .
• You'll also need to make sure that graphviz is installed on your machine.
• Change to the docs directory and build the docs
  • python -m sphinx -b html -v source build
• Checkout the gh-pages branch
  • git checkout gh-pages
• Create a new branch from gh-pages
  • git checkout -b gh-pages-update
• Move existing docs (for the previous release) in the root directory of the repository into a new subfolder if necessary.
• Move the docs in docs/build to the root directory of the repository.
• Commit the changes, and make a PR.