How to contribute¶

Make sure you meet the requirements to use the project, first.

Requirements¶

To install required dependencies, use the command:

$ pipenv install --dev

This will install in your local virtualenv all the required dependencies to contribute to this project.

The --dev option allows the installation of the dev-packages dependencies.

pip install --user -U setuptools wheel twine

You need to update two different files :

setup.py: contains the VERSION constant, used to identify the version built and uploaded to the nexus.
sphinxcontrib/versioning/__init__.py: contains the __version__ constant, used to identify the package version.

You need to add a section in the README.rst for the newly created version (follow the pattern of other versions).

This builds your python project and creates the dist directory (among other things).

python3 setup.py sdist bdist_wheel

twine upload dist/*

After this command, your package is available on https://pypi.org. Anyone can install it using pip install sphinx-versions.