Skip to main content

Sphinx "taglist" extension

Project description

Sphinx “taglist” extension.


Taglist is an extension to Sphinx documentation system.


Instalation through pip:

pip install sphinxcontrib-taglist

or through github:

git clone
cd sphinxcontrib-taglist
python install

Next, you have to add extension to ‘’ in your sphinx project.

extensions = [


When using tags with this extension you may want give each tag other color. You can do that in ‘’ by adding:

taglist_tags = {
    'tag1': {'background-color': 'green'}



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


.. tag:: [tag1 tag2 tag3] Some tagged information

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.



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; 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

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-taglist-0.2.tar.gz (5.4 kB view hashes)

Uploaded source

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