sphinx-tags

A tiny Sphinx extension that implements blog-style tags for documentation.

🗣 If you use this extension in your project, please drop us a note in this discussion post

Installation

After activating a virtual environment manager such as venv or conda, use

python -m pip install sphinx-tags

or

conda install sphinx-tags -c conda-forge

Usage

Refer to the documentation for usage instructions.

Contributing

Feel free to submit issues or PRs - keep in mind this project is experimental!

Setup for development

After cloning this repo and activating a virtual environment manager such as venv or conda, use

python -m pip install -e ".[sphinx]"

To build the documentation locally, use

sphinx-build docs docs/_build/html

sphinx-tags uses pre-commit, and code is formatted according to black

Contribution guide

If you want to submit Pull requests to this repository, please follow the contribution guidelines.

Code of Conduct

All contributors and maintainers are expected to follow the PSF Code of Conduct.

Notes

This project is loosely based on this StackOverflow answer.