Metadata-Version: 2.1
Name: pangeo-sphinx-book-theme
Version: 0.2
Summary: Pangeo's customized version of the Sphinx Book Theme.
Home-page: https://github.com/pangeo-forge/pangeo-sphinx-book-theme/
Author: Ryan Abernathey
Author-email: rpa@ldeo.columbia.edu
Maintainer: Charles Stern
Maintainer-email: cstern@ldeo.columbia.edu
License: MIT
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: OS Independent
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx
Requires-Dist: sphinx-book-theme

# Pangeo Sphinx Book Theme

[![PyPI version](https://badge.fury.io/py/pangeo-sphinx-book-theme.svg)](https://badge.fury.io/py/pangeo-sphinx-book-theme)

This is a theme for [Sphinx](http://sphinx-doc.org/) that inherits from the
[Sphinx Book Theme](https://github.com/executablebooks/sphinx-book-theme).

It is used for the [Pangeo Forge documentation](https://pangeo-forge.readthedocs.io/en/latest/) 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](https://nox.thea.codes/).
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`.
