Getting Started

The logikal-docs package provides the docs command-line tool which simplifies Python documentation building and management.

You can install logikal-docs from pypi:

pip install logikal-docs

Once installed, you may build your documentation by executing docs -b in the root of your Python project, after which you can open your current documentation in the browser by executing docs. You can always access a short usage help by executing docs --help or docs -h.

Configuration

The documentation is built with Sphinx using the Read the Docs Sphinx theme. Note that we pre-configure Sphinx building and output and we also read out and forward the necessary project information from your pyproject.toml file, therefore you typically only need to add and configure your own extensions in your docs/conf.py file (which is now optional).

We use the available git tags starting with v[0-9] to identify the current version and to populate the automatically generated version selection panel.