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

Uploaded Source

Built Distribution

sphinx_tags-0.1.2-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-tags-0.1.2.tar.gz
Algorithm Hash digest
SHA256 958217252c90f7c63bd58954a34d447a5fdb971c953deed50d89f270a6cce0ca
MD5 c01fae158e1b14cc26f4ce242d6567f0
BLAKE2b-256 0b7482738580d76e48a43c838afc8aeaac5e416af2fb24309064e66423c9eb71

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2d3b36f0cfb044fcd8565fcb45868756a2a4f429fd37ea11578a3bb24c55fbab
MD5 886c728ee7f662e22a51d751971b03fe
BLAKE2b-256 e036fe3402828055f88e0daee3609b6dedc7fc8202789a044bbe79ef70e116b4

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