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

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

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

Uploaded Source

Built Distribution

sphinx_tags-0.1.6-py2.py3-none-any.whl (5.6 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-tags-0.1.6.tar.gz
Algorithm Hash digest
SHA256 0efc248ae4c99fd4f5dbeba499546fabf5adabcbc601d65f78b01f99605dffc9
MD5 24af9c669b565dd3b3cda62cb431689f
BLAKE2b-256 edef08b11339ae132c37875cf3abbe116b5131a5e8a9da2a837c0eb5180abf4c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.1.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 026934f44799757ba3d82016ee43770c8ee4dad84a5725b606ac11db1fe43a8f
MD5 1e62d1d6406cdc8c75382946b0dd5085
BLAKE2b-256 46a3b648e6b2a2e0a89d1af3fcd47dd38f217a99b35354cbbb56c7cb2e232183

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