Skip to content

jahn-junior/sphinx-relabel

Repository files navigation

sphinx-relabel

sphinx-relabel adds a Sphinx directive that generates a custom greeting.

Basic usage

Project setup

sphinx-relabel is published on PyPI and can be installed with:

pip install sphinx-relabel

After adding sphinx-relabel to your Python project, update your Sphinx's conf.py file to include sphinx-relabel as one of its extensions:

extensions = [
    "sphinx-relabel"
]

Community and support

You can report any issues or bugs on the project's GitHub repository.

If you're interested in contributing to sphinx-relabel, start with the contribution guide.

License and copyright

sphinx-relabel is released under the GPL-3.0 license.

About

Redirect labels that have been removed or renamed in your Sphinx docs.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published