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

Uploaded Source

Built Distribution

sphinx_tags-0.1.1-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.1.tar.gz.

File metadata

  • Download URL: sphinx-tags-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 c1a7b4a58e7832f61b476d14e225a452656473812883739204e8209f0af09476
MD5 670f6259d0fa237584f29b3bdf5e683d
BLAKE2b-256 7e6e8aec329e56e090e923508344a4dfd0993a84c36895b665c50e5068b17e49

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6d3f83d9d25b577a80e59aa4f9c3aa7c96d5259beeaad24ab78309cb0169dfab
MD5 c4154e3de10cfe362baec40ef8000ab9
BLAKE2b-256 7f69d4d3e4693876c5cedfc2540ea66024309abbcefdb871e4e7672b35cd7e70

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