Sphinx "taglist" extension
Project description
Sphinx “taglist” extension.
TagList
Taglist is an extension to Sphinx documentation system.
Installation
Instalation through pip:
pip install sphinxcontrib-taglist
or through github:
git clone https://github.com/spinus/sphinxcontrib-taglist cd sphinxcontrib-taglist python setup.py install
Next, you have to add extension to ‘conf.py’ in your sphinx project.
extensions = [ ..., 'sphinxcontrib.taglist', ...]
Configuration
When using tags with this extension you may want give each tag other color. You can do that in ‘conf.py’ by adding:
taglist_tags = { 'tag1': {'background-color': 'green'} }
Directives
- tag:
tag directive add a ‘piece’ of information, and you can tag it.
You can use it like:
.. tag:: Some tagged information :tag: tag1 tag2 tag3
or:
.. tag:: [tag1 tag2 tag3] Some tagged information
- taglist:
taglist is a directive which catch tags and do a list.
Firstly it prints ‘Tags: …’ with information which tags it displays, and than it shows the list.
You can use it like:
.. taglist:: :tags: tag1 tag3
How it works?
The codebase is derived from sphinxcontrib-requirements so it works in similar way.
During document reading tag directives create tag_node`s. `taglist create taglist nodes.
During resolving taglist nodes are changed to a piece of text Tags: with tags items which will be displayed on that list. Next it prints all tagged items.
CSS
- taglist.css:
It contains base class for tag - taglist_tag
Additionally, it creates the file taglist_tags.css during processing (with css for each tag you defined in conf.py; taglist_tags maps all tag keys to css keys) and write it to build directory to static files.
Questions and suggestions
If you have some suggstions, patches, problems - please write an email.
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
Hashes for sphinxcontrib-taglist-0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbc8860e9e25855a4d963523cb9d998830526827aee28ba51fdae9618a41ecf2 |
|
MD5 | 6c68a5976ae60ee9749f1d9596879354 |
|
BLAKE2b-256 | c8f0231939b8261ce4fa065962edd1535773a3ca4355ef0e60dd9b886f635ac9 |