Skip to main content

Pangeo's customized version of the Sphinx Book Theme.

Project description

Pangeo Sphinx Book Theme

PyPI version

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pangeo_sphinx_book_theme-0.2.tar.gz (163.5 kB view hashes)

Uploaded Source

Built Distribution

pangeo_sphinx_book_theme-0.2-py3-none-any.whl (113.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page