Skip to main content

Jupyter Alabaster Theme

Project description

# Jupyter Alabaster Theme

[![Documentation Status](](

A Sphinx theme for Jupyter based on the [Alabaster theme](

To use this theme on any Sphinx based documentation, follow these steps:

## Installation

Install the `jupyter_alabaster_theme` package using pip:

pip install jupyter_alabaster_theme

## Configuration

To use the theme in your Sphinx based documentation, follow these steps. For further
details, see the documentation for this theme [here](

### Edit ``

Most of the work to use the theme is in editing your `` file that configures

First, You will need to set the theme itself to `jupyter_alabaster_theme`:

html_theme = 'jupyter_alabaster_theme'

Second, you will need to add `jupyter_alabaster_theme` to the list of extensions:

extensions = [

Finally, at the bottom of ``, the following block of code, if present, should be removed:

if not on_rtd:
# only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

### Update documentation dependencies

To get your documentation to build, you will need to update its build dependencies. Update your `environment.yml` or `requirements.txt` to depend on `jupyter_alabaster_theme` to get the build working on ReadTheDocs. Note, we have not yet released a [Conda]( package for this theme, so you will need to list it in the `environment.yml` file under the `pip` section.

## Questions

If you have questions about this project, please go to our Gitter channel:

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

jupyter_alabaster_theme-0.4.0.tar.gz (198.6 kB view hashes)

Uploaded source

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