sphinx-highlights¶
Sphinx extension to display a selection of highlights from a Python library.
Installation¶
python3 -m pip install sphinx-highlights --user
First add the required channels
conda config --add channels https://conda.anaconda.org/conda-forge
conda config --add channels https://conda.anaconda.org/domdfcoding
Then install
conda install sphinx-highlights
python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-highlights@master --user
Enable seed_intersphinx_mapping
by adding the following
to the extensions
variable in your conf.py
:
extensions = [
...
'seed_intersphinx_mapping',
]
For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .