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

Uploaded Source

Built Distribution

sphinx_tags-0.1.4-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.4.tar.gz.

File metadata

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

File hashes

Hashes for sphinx-tags-0.1.4.tar.gz
Algorithm Hash digest
SHA256 5579192267b8c30127f8b70ac25b7b6029eadfd62bf3f3899993e0d6054f08c9
MD5 d198010d6951bcc344e13bfa3fceacea
BLAKE2b-256 ce5f1e92685161607840c616d693a7db6bee0d36a997fff04287786f7ac27f5e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_tags-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 307ffe355ca0768affc49303efa1ceff1465ef1d05052435041ca9798043af0d
MD5 3fb5ad074192036137d7408d41430316
BLAKE2b-256 8ed9d7e79e519bbc1b2fb2ad89183f39cbd3a8958459b7a9e5f6f86d673c36c0

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