sphinxcontrib-标记列表是一个狮身人面像“标记列表”扩展名。
标记列表
标记列表是一个扩展,狮身人面像的文件系统。
安装
安装目录到点子:
PIP安装sphinxcontrib,标记列表
或者通过github上:
混帐克隆https://github.com/spinus/sphinxcontrib-taglist
CD sphinxcontrib-标记列表
蟒蛇setup.py安装
接下来,你必须在你的狮身人面像项目中添加扩展名“conf.py”。
扩展= [
  ...
 “sphinxcontrib.taglist',
  ...]
配置
当使用标签与该扩展你可能想给每个标签等颜色。你可以这样做,在“conf.py”加入:
taglist_tags = {
 “TAG1”:{“背景色”:“绿色”}
}
指令
标签:
 标签指令添加信息的“块”,你可以标记它。
 你可以使用它,如:
  ..标签::一些标记信息
 :标签:标签1 TAG2 TAG3
 或:
  ..标签:: [标签1 TAG2 TAG3一些标记信息
 警告:第二个方法是只使用,如果第一种方法是没有的。
 警告:我不知道这个语法,它可能会改变。如果你有ANNY建议,请让我知道。
标记列表:
 标记列表是赶上标签,做一个列表中的指令。
 首先它打印“标签:...'与标签则显示,和比它显示列表信息。
 你可以使用它,如:
  ..标记列表::
 :标签:标签1 TAG3
它是如何工作的?
该代码库是从sphinxcontrib,要求派生因此它的工作方式类似。
在文档阅读标签指令创建tag_node`s。 `标记列表创建标记列表节点。
在解决标记列表节点变成一块文本标签:与将在名单上显示的标签项。接下来,它打印的所有标签的物品。
CSS
taglist.css:
 它包含标记基类 - taglist_tag
 警告:这可能会改变,放入taglist_tags.css。 (这将是从conf.py配置)
此外,它在处理过程中创建文件taglist_tags.css(使用CSS为你conf.py定义的每个标签; taglist_tags所有标记键映射到CSS的键)。并将其写入建立目录的静态文件
要求:
- 在Python中
- 在狮身人面像
评论没有发现