Skip to content

sphinx-toolbox/sphinx-highlights

Repository files navigation

sphinx-highlights

Sphinx extension to display a selection of highlights from a Python library.

Docs Documentation Build Status Docs Check Status
Tests Linux Test Status Windows Test Status macOS Test Status Coverage
PyPI PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel
Anaconda Conda - Package Version Conda - Platform
Activity GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads
QA CodeFactor Grade Flake8 Status mypy status
Other License GitHub top language Requirements Status

See the documentation for a demo.

Installation

sphinx-highlights can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install sphinx-highlights

To install with conda:

  • 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