Skip to main content

Sphinx extension to create tags for documentation pages.

Project description

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

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

Uploaded Source

Built Distribution

sphinx_tags-0.0.2-py2.py3-none-any.whl (4.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for sphinx-tags-0.0.2.tar.gz
Algorithm Hash digest
SHA256 00a551200169ee7e58995a8c0d00173fddfc1d67301fd1603f1dca165476b53f
MD5 d86366bc89f40b58a0af0b4f81524dd5
BLAKE2b-256 73f790be49282bafef22c412e7b361016dbbf6966d39f97eb690890562eae9a7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3569746b2518d3a71e51d3b181a3b3b642d168519d1fda4ad3aef1967525cf58
MD5 896e82f2fb8b8aec31646b52d067f616
BLAKE2b-256 df76f9be0cd7d93832cd5a764becc082e9cbea51f402829d34851322467332ec

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