Skip to main content

Sphinx extension to create tags for documentation pages.

Project description

sphinx-tags sphinx-tags

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

Installation

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

python -m pip install sphinx-tags

Usage

Refer to the documentation for usage instructions.

Contributing

Feel free to submit issues or PRs - keep in mind this 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

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

Uploaded Source

Built Distribution

sphinx_tags-0.0.3-py2.py3-none-any.whl (4.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinx-tags-0.0.3.tar.gz.

File metadata

  • Download URL: sphinx-tags-0.0.3.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for sphinx-tags-0.0.3.tar.gz
Algorithm Hash digest
SHA256 c5062009d2f8aad78d8c4edbad29031d49b623f5fe0373e70841514da9575421
MD5 c6aa064bc2fa80832795aad70a97c1c8
BLAKE2b-256 4adde648a38f0624b05643eb0198f65fb386c7af063e7f1138f02b14ddfc4bba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ac7ece655d723c61a31c4c7c76ce08994c46c8783273e02e851f429b2188015e
MD5 0505fc77665fba1dd52015103b47ad15
BLAKE2b-256 d9d3ee817bc5a2f226329f577d5c6dd0cd109e05860e932277906fbbfed7c7a4

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