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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pangeo_sphinx_book_theme-0.2.tar.gz.

File metadata

File hashes

Hashes for pangeo_sphinx_book_theme-0.2.tar.gz
Algorithm Hash digest
SHA256 5c5fed269b594daab7fe3bd3a1a199afcee35b8f860c84c75b85775d5abd02e6
MD5 28af94d691c0b5b79df927c7a685627d
BLAKE2b-256 2b711eaa0c7f9bbe40cb597b19ed10d285c602fc2a757d585370c955090266ed

See more details on using hashes here.

Provenance

File details

Details for the file pangeo_sphinx_book_theme-0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pangeo_sphinx_book_theme-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 36c64e0d5a241d320659b2abea3bd3563493b74ffe69c66cf2d8249e7a68cf28
MD5 70233e5739bbd2606c31f678254dac78
BLAKE2b-256 6e343d70886b3bcfb1f4f23fb27e2b88dfce826adb2a90d59dcd649e83af7f65

See more details on using hashes here.

Provenance

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