Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

# Jupyter Alabaster Theme

A Sphinx theme for Jupyter based on the [Alabaster theme](https://alabaster.readthedocs.io/en/latest/).

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

## Installation

Install the `jupyter_alabaster_theme` package using pip:

```bash
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 `conf.py`

Most of the work to use the theme is in editing your `conf.py` file that configures
Sphinx.

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

```python
html_theme = 'jupyter_alabaster_theme'
```

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

```python
extensions = [
...
'jupyter_alabaster_theme',
]
```

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

```python
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](https://conda.io/docs/intro.html) 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:

https://gitter.im/jupyter/jupyter

Metadata

Release files for jupyter-alabaster-theme 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyter-alabaster-theme 0.2.0
File Size Uploaded Provenance Actions
jupyter_alabaster_theme-0.2.0.tar.gz 194.2 kB Without provenance Details for jupyter_alabaster_theme-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jupyter-alabaster-theme 0.2.0
File Interpreter ABI Platform Actions
jupyter_alabaster_theme-0.2.0-py2.py3-none-any.whl Python 3, Python 2 none any Details for jupyter_alabaster_theme-0.2.0-py2.py3-none-any.whl

Total release size: 397.1 kB

Release files / jupyter_alabaster_theme-0.2.0.tar.gz

Download URL jupyter_alabaster_theme-0.2.0.tar.gz
Size 194.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d5c0abc9dbbe76fc45271c74566e668edec5dd8cbca2be4aad43d3759589725f
BLAKE2b-256 checksum
How to use checksums
081af9b448c9e7cb43a11d411aaf9ec0de941f82d71f8547be3734d668dc6716
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / jupyter_alabaster_theme-0.2.0-py2.py3-none-any.whl

Download URL jupyter_alabaster_theme-0.2.0-py2.py3-none-any.whl
Size 202.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
a1c0f83471d35249c49b9977d1ceef80770e7461736d38013f73805712b91647
BLAKE2b-256 checksum
How to use checksums
3628edb20ed8e347a297661dd75a04ee331320c43353ef33da6a285b28cccf23
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for jupyter-alabaster-theme 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page