Installation Tutorial

Note

For installation inside DLS, please see the internal documentation on dls-python3 and pipenv. Although these instructions will work inside DLS, they are intended for external use.

If you want to contribute to the library itself, please follow the Contributing instructions.

Check your version of python

You will need python 3.7 or later. You can check your version of python by typing into a terminal:

python3 --version

Create a virtual environment

It is recommended that you install into a “virtual environment” so this installation will not interfere with any existing Python software:

python3 -m venv /path/to/venv
source /path/to/venv/bin/activate

Installing the library

You can now use pip to install the library:

python3 -m pip install sphinx-apischema

If you require a feature that is not currently released you can also install from github:

python3 -m pip install git+git://github.com/dls-controls/sphinx-apischema.git

Including in Sphinx Documentation

Add sphinx_apischema to the extensions list in the conf.py file for your documentation. For example:

extensions = [
    # <Preexisting config>
    ...,
    # Use this for generating API docs
    "sphinx.ext.autodoc",
    # Makes autodoc understand apischema annotated classes/functions
    "sphinx_apischema",
]