Skip to main content

Documentation using Sphinx


Installation

python3 -m pip install \
sphinx \
sphinxcontrib-napoleon \
sphinx-rtd-theme \
myst-parser \
sphinxcontrib-mermaid \
rinohtype

Configuration

<project>
├── MANIFEST.in
├── pyproject.toml
├── py_src
│ ├── conf.py
│ ├── index.md
│ └── <package>
│ ├── __init__.py
│ └── README.md
├── README.md
├── setup.cfg
├── setup.py
└── ...

conf.py

py_src/conf.py
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import sys

sys.path.insert(0, os.path.abspath("."))


# -- Project information -----------------------------------------------------

project = <package>
copyright = "2021, <author>"
author = <author>

# The full version, including alpha/beta/rc tags
release = "0.0.1"


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.

# https://myst-parser.readthedocs.io/
# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
# https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
# http://www.mos6581.org/rinohtype/master/index.html
# https://mermaid-js.github.io/mermaid/
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinxcontrib.mermaid",
]

autodoc_class_signature = "separated"

autodoc_mock_imports = []

napoleon_google_docstring = True
napoleon_numpy_docstring = False
napoleon_include_init_with_doc = True
napoleon_include_private_with_doc = True
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = False
napoleon_use_admonition_for_notes = False
napoleon_use_admonition_for_references = False
napoleon_use_ivar = False
napoleon_use_param = False
napoleon_use_rtype = False
napoleon_preprocess_types = False
napoleon_type_aliases = None
napoleon_attr_annotations = True

rinoh_documents = [
{
"doc": "index",
"target": f"{project}",
# "logo": None,
"toctree_only": False,
}
]

# https://github.com/mgaitan/sphinxcontrib-mermaid
mermaid_output_format = "raw"
mermaid_params = [
"--theme",
"forest",
"--width",
"600",
"--backgroundColor",
"transparent",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = []

# 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 = []

source_suffix = {
".rst": "restructuredtext",
".txt": "markdown",
".md": "markdown",
}

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "sphinx_rtd_theme"

# 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 = []

index.md

py_src/index.md
# <package>

```{eval-rst}
.. toctree::
:maxdepth: 2
:caption: Contents:
```

# Module

```{eval-rst}
.. toctree::
:maxdepth: 3

<package>/README
```

# Etc

- [](genindex)

Build

sphinx-build -b html py_src docs/build/html

Reference