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