To use this theme on any Sphinx based documentation, follow these steps:
Install the jupyter_alabaster_theme
package using pip:
pip install jupyter_alabaster_theme
Edit your conf.py
file:
jupyter_alabaster_theme
:html_theme = 'jupyter_alabaster_theme'
jupyter_alabaster_theme
to the list of extensions:extensions = [
...
'jupyter_alabaster_theme',
]
conf.py
, if the following block of code is present,
remove it: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.
captions
in the toctree
since that is not accessible to mobile
navigation menus and the breadcrumbs.toctree
.
Subsections are not accessible to the mobile navigation menus and breadcrumbs.
This can be avoided by limiting maxdepth
for a toctree
. Another option is
to set the titlesonly
option:.. toctree:: :titlesonly: title1 title2
toctree
can be found at the Sphinx documentation
sitehtml_sidebars
to include a custom sidebar navigation
template. If you want to use different sidebar templates, simply set your own
in conf.py
, to override the theme’s defaults. Otherwise you can add more by:html_sidebars.update(
# Additional sidebars can be added here
)