Sphinx extension to create tags for documentation pages.

Project description

sphinx-tags

A tiny Sphinx extension that implements blog-style tags for documentation.

🗣 If you use this extension in your project, please drop us a note in this discussion post

Installation

After activating a virtual environment manager such as venv or conda, use

python -m pip install sphinx-tags

conda install sphinx-tags -c conda-forge

Usage

Refer to the documentation for usage instructions.

Contributing

Feel free to submit issues or PRs - keep in mind this project is experimental!

If you want to submit Pull requests to this repository, please follow the contribution guidelines.

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

Release history Release notifications | RSS feed

0.4

Jul 8, 2024

This version

0.3.1

Nov 6, 2023

0.3.0 yanked

Oct 30, 2023

Reason this release was yanked:

Wrong requirements causes broken environment.

0.2.1

Jun 28, 2023

0.2.0

Jan 28, 2023

0.1.6

Oct 9, 2022

0.1.5

Sep 2, 2022

0.1.4

Sep 1, 2022

0.1.3

Aug 31, 2022

0.1.2

Aug 23, 2022

0.1.1

Aug 23, 2022

0.1

Aug 23, 2022

0.0.3

Aug 22, 2022

0.0.2

May 18, 2022

0.0.1

May 18, 2022

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

Uploaded Nov 6, 2023 Source

Built Distribution

sphinx_tags-0.3.1-py2.py3-none-any.whl (6.6 kB view details)

Uploaded Nov 6, 2023 Python 2 Python 3

File details

Details for the file sphinx_tags-0.3.1.tar.gz.

File metadata

Download URL: sphinx_tags-0.3.1.tar.gz
Upload date: Nov 6, 2023
Size: 14.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for sphinx_tags-0.3.1.tar.gz
Algorithm	Hash digest
SHA256	`18b6eedba095665b49a19ca479fc0afde0b24644ffb35633d0f6bf982a37ab6e`
MD5	`206879ad3b3411a7a8fb6f5b7b7e954d`
BLAKE2b-256	`d2d25098b390e46701403d3c1d1bce54770d25236d3d31925702579a8db142c2`

See more details on using hashes here.

File details

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

File metadata

Download URL: sphinx_tags-0.3.1-py2.py3-none-any.whl
Upload date: Nov 6, 2023
Size: 6.6 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for sphinx_tags-0.3.1-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`9384bf687b878ba17b0c52db29fd3fa5a09198c49c82d2654840b0950bf535e3`
MD5	`f8d024ec059d11d01c8bc71a9cb8e2cf`
BLAKE2b-256	`f215370c8ae95b31efedb92e2ac4ba53e7dac25cd2b49b28d578c3a7468b2bdf`