Skip to main content

Sphinx extension to create tags for documentation pages.

Project description

sphinx-tags sphinx-tags Codecov

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!

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_tags-0.3.1.tar.gz (14.0 kB view hashes)

Uploaded Source

Built Distribution

sphinx_tags-0.3.1-py2.py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page