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.4.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

sphinx_tags-0.4-py2.py3-none-any.whl (7.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx_tags-0.4.tar.gz.

File metadata

  • Download URL: sphinx_tags-0.4.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sphinx_tags-0.4.tar.gz
Algorithm Hash digest
SHA256 3065219bacf47567c706f2237d5665b22f3a5167367b4c4568bcda4371a5359d
MD5 a81dba544b8f161a758fc5311c5e6c85
BLAKE2b-256 10decd7669ce4619bf03418d428b4e68f20bc90f9de0d9ed36b1d43147d6e96d

See more details on using hashes here.

File details

Details for the file sphinx_tags-0.4-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinx_tags-0.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sphinx_tags-0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 af31203fe4e0ebd39cb95d4fef38720185def6af9fdb921b70275ff659a5dac5
MD5 48bc4d63069972f26a5dd4efde26e3a0
BLAKE2b-256 70711fb5aa2013e04d36e6940b308e65608a48e2d5f59f2a21c98f01f2ce0b85

See more details on using hashes here.

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