Skip to content
Back to top
View this page
Edit this page

# Installation

The basic library can be installed with pip:

    ?> pip install sphinxcontrib-typer

There are several optional dependency sets that are involved in more advanced automated rendering. If you want to use selenium to automatically determine the heights of the iframes when rendering in html you should install the html extras:

    ?> pip install sphinxcontrib-typer[html]

If you wish to convert rendered docs to png images you’ll need the png dependency set:

    ?> pip install sphinxcontrib-typer[png]

If you wish to convert rendered docs to pdf format you’ll need the pdf dependency set:

    ?> pip install sphinxcontrib-typer[pdf]

Once installed you need to add `sphinxcontrib.typer` to your `conf.py` file:

    # be sure that the commands you want to document are importable
    # from the python path when building the docs
    import sys
    from pathlib import Path
    sys.path.insert(0, str(Path(__file__).parent / 'path/to/your/commands'))

    extensions = [
        ...
        'sphinxcontrib.typer',
        ...
    ]