Jupyter Alabaster Theme
Project description
# 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
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
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.2.0.tar.gz
(194.2 kB
view hashes)
Built Distribution
Close
Hashes for jupyter_alabaster_theme-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5c0abc9dbbe76fc45271c74566e668edec5dd8cbca2be4aad43d3759589725f |
|
MD5 | 889601fb97a56b612e995133d1fe0222 |
|
BLAKE2b-256 | 081af9b448c9e7cb43a11d411aaf9ec0de941f82d71f8547be3734d668dc6716 |
Close
Hashes for jupyter_alabaster_theme-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1c0f83471d35249c49b9977d1ceef80770e7461736d38013f73805712b91647 |
|
MD5 | b9239c895afc18164892bd53f09bb936 |
|
BLAKE2b-256 | 3628edb20ed8e347a297661dd75a04ee331320c43353ef33da6a285b28cccf23 |