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

Uploaded Source

Built Distribution

sphinx_tags-0.1-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-tags-0.1.tar.gz
Algorithm Hash digest
SHA256 aa1a52fd3fee1a975275351bfab6506ea9806480b54491a60e53849cc21e4925
MD5 f27438aa40c257609fefc96e86285d0f
BLAKE2b-256 76ecb35ef4ac19b024b623fd86178f453fceb6cd31a781146834616c2379a91a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sphinx_tags-0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for sphinx_tags-0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dbe084d8ae224d8d976a34086994036eabb7f80909bf50aa5b3e1080ded14280
MD5 db13e7ee6555a876ca31b29e27893a5b
BLAKE2b-256 291d08ce4a9ec79f9246e4d6c97e4b01d70f3a948a2537757d4b436595dd2fe7

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