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

Uploaded Source

Built Distribution

sphinx_tags-0.1.3-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-tags-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e8a67d0829e44a08df5cbdae675f53fcb10ccaa947fa80b6197b9c47482b86e8
MD5 e6e9f527ba7a39500046770284cea54f
BLAKE2b-256 4e75f57bec9131b03b5bdec6cd25de230e96dcda2407cca39137dc1e33cb570d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6a8cb311984cae997160de713bba47209a9ab15c2eeab28738fe16a54ac4e2eb
MD5 4c8772d3b7defcefb27130328e69529a
BLAKE2b-256 7d8b058210322c250ffdb65242be6bbdceea3a43faf477188cc95ef25961c309

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