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

Uploaded Source

Built Distribution

sphinx_tags-0.1.5-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.5.tar.gz.

File metadata

  • Download URL: sphinx-tags-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 784ce90c21490660bd7802653ca88389e2b827507173f443333d29efcc95b761
MD5 e7b92fa04916548f9c2fba527ceb90b9
BLAKE2b-256 fd5564b1c0eab58f6125f1ea0b23b9e6a9cd84cd55ad80f1515e883eb2f54f08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cca1de9d10cde21e96c6f20da96280ea8768f6d57c127cfd05cc759e6fbd4326
MD5 18fef7eaaee100cec9e7a58b4fca93f5
BLAKE2b-256 354b2b3a8ddf27bb74c3474a7fae4c9e393dd5f75fbca5188d6c6dca1f250950

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