Contributing

You will need to set up a development environment to make and test your changes before submitting them.

Local development

  1. Clone the sphinx-sitemap repository.

  2. Create and activate a virtual environment:

    python3 -m venv .venv
source .venv/bin/activate

  3. Install development dependencies:

    pip3 install -r requirements_dev.txt

  4. Install pre-commit Git hook scripts:

    pre-commit install

Install a local copy of the extension

Add sphinx-sitemap as a third party extension.

  1. If your project doesn't have an extensions directory, create _exts and point conf.py to it:

    sys.path.append(os.path.abspath('../_exts'))

  2. Copy sphinx_sitemap as a directory in your project's extensions directory, and rename it to sphinx_sitemap_dev.

  3. Add sphinx_sitemap_dev to extensions, or if already installed via pip, change sphinx_sitemap to sphinx_sitemap_dev in conf.py:

    extensions = ['sphinx_sitemap_dev']

You can now make changes to sphinx_sitemap_dev.

Testing changes

Run tox before committing changes.

Current contributors

Thanks to all who have contributed! The people that have improved the code: