Building and Uploading the Documentation - soft-matter/trackpy GitHub Wiki

The documentation requires trackpy and trackpy-examples. The repos are expected to be next to each other, stored in the same directory.

Requirements

pip install sphinx_bootstrap_theme nbconvert numpydoc

Note that as of February 2023, the docs would not build successfully with Python 3.10. Use Python 3.9 instead.

Building the docs

The first time only, you must create a branch called gh-pages. Then checkout whatever branch you wish to build the docs from.

From the directory trackpy/doc,

make notebooks
make html

Uploading the docs

This publishes the built docs to the dev directory in the docs repository:

• Make sure you have the soft-matter.github.io repository cloned into a directory alongside your trackpy project.
• force-pull the docs repository (git fetch --all, git reset --hard origin/master or upstream/master depending on how you're set up)
• Inside this repository, rm -r trackpy/dev
• mv ../trackpy/doc/_build/html trackpy/dev
• Commit and push the docs repository
• View the new dev docs