sphinxcontrib-taglist Sphinx "taglist" extension
Download

sphinxcontrib-taglist Ranking & Summary

sphinxcontrib-taglist Tags

extension Sphinx Sphinx extension

sphinxcontrib-taglist Description

sphinxcontrib-taglist is a Sphinx "taglist" extension.TagListTaglist is an extension to Sphinx documentation system.InstallationInstalation through pip:pip install sphinxcontrib-taglistor through github:git clone https://github.com/spinus/sphinxcontrib-taglistcd sphinxcontrib-taglistpython setup.py installNext, you have to add extension to 'conf.py' in your sphinx project.extensions = ConfigurationWhen 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'}}Directivestag: 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:: Some tagged information Warning: Second method is used only if first method is not. Warning: I am not sure this syntax, it may change. If you have anny suggestions please let me know.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 tag3How 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.CSStaglist.css: It contains base class for tag - taglist_tag Warning: It probably will be changed and put in taglist_tags.css. (And it will be configurable from conf.py)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.Product's homepage

sphinxcontrib-taglist Related Software