Welcome to napari Sphinx Theme’s documentation!#
This is the official Sphinx theme for napari documentation. It extends the pydata_sphinx_theme project, but adds custom styling.
Use it by changing this line in your conf.py file
html_theme = 'napari_sphinx_theme'
And by including napari_sphinx_theme
as a requirement in your documentation
installation.
Configuration for this demo#
The full conf.py
is
import os
import time
import datetime
from napari_sphinx_theme import __version__
version = __version__
# Parse year using SOURCE_DATE_EPOCH, falling back to current time.
# https://reproducible-builds.org/specs/source-date-epoch/
build_date = datetime.datetime.utcfromtimestamp(
int(os.environ.get("SOURCE_DATE_EPOCH", time.time()))
)
# -- Project information -----------------------------------------------------
project = "napari Sphinx Theme"
copyright = f"2023 - {build_date.year} napari Community"
author = "napari Community"
# -- General configuration ---------------------------------------------------
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
extensions = [
"sphinx_design",
]
# -- Options for HTML output -------------------------------------------------
html_theme = "napari_sphinx_theme"
# Define the json_url for our version switcher.
json_url = "https://napari.org/napari-sphinx-theme/_static/switcher.json"
if "dev" in version:
version_match = "latest"
# We want to keep the relative reference if we are in dev mode
# but we want the whole url if we are effectively in a released version
json_url = "_static/switcher.json"
else:
version_match = version
html_context = {
"default_mode": "auto",
}
html_theme_options = {
"show_toc_level": 1,
"show_prev_next": False,
"navbar_end": ["version-switcher", "navbar-icon-links", "theme-switcher"],
"switcher": {
"json_url": "https://napari.org/napari-sphinx-theme/_static/switcher.json",
"version_match": version_match,
},
"pygments_light_style": "napari",
"pygments_dark_style": "dracula",
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ["_static"]
html_sidebars = {
"**": [
"search-field",
"sidebar-nav-bs",
],
}