Pangeo Sphinx Book Theme

This is a theme for Sphinx that inherits from the Sphinx Book Theme.

It is used for the Pangeo Forge documentation and related projects.

Build the documentation

This site comes bundled with a small documentation site to make it easy to preview what the theme looks like.

The easiest way to build the documentation is to us the nox command line tool. This is kind-of like a Makefile that is bundled with an isolated local environment.

To build the documentation with nox, run this command:

nox -s docs

To build the documentation with a live server that auto-reloads when you make changes to docs/, run this command:

nox -s docs-live

Configuration for nox can be found in noxfile.py.