Installation
This tool can be installed as a os-independent python package. You will therefore need a Python installation and a python package manager like pip. Sphinx-polyversion is available on pypi.org. But you can also install the package directly from its git repository.
Sphinx-polyversion provides integration with virtualenv and jinja. By specifying the respective dependency groups you can install them alongside the tool.
pip install sphinx-polyversion[jinja,virtualenv]
poetry add --group docs sphinx-polyversion[jinja,virtualenv]
pipenv install --dev sphinx-polyversion[jinja,virtualenv]
Note
The minimum supported Python version is 3.8.
Installing from Source
If you want to setup a development environment refer to this guide.
pip install git+https://github.com/real-yfprojects/sphinx-polyversion[jinja,virtualenv]
poetry add --group docs git+https://github.com/real-yfprojects/sphinx-polyversion[jinja,virtualenv]
pipenv install --dev git+https://github.com/real-yfprojects/sphinx-polyversion[jinja,virtualenv]