Sphinx通用节点“todo like”扩展
项目描述
通用“todo like”节点。
您喜欢sphinx-ext-todo，并希望有更多类似指令？
本扩展正是为您准备的。
使用zc.buildout| pip | easy_install安装我，或克隆并使用setup.py install|develop，然后将以下内容添加到您的conf.py中
extensions = ['sphinxcontrib.gen_node']
gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False),]
说明
gen_nodes是一个元组列表，对于每个元素，您现在可以在文档中添加，就像使用“sphinx-ext-todo”一样
新的sample_one指令
.. sample_one:: one thing
新的sample_onelist指令
.. sample_onelist::
如果您在conf.py中的gen_nodes中将第二个参数设置为False，则sample_onelist不会出现在您的文档中 [(‘sample_one’，False，False，False)，…
选项
sample_one是您的新警告名，您将编写
.. sample_one:: A text here第一个（True|False）参数启用列表，请注意，“list directive”的形式始终是“namenode”+list，即
.. sample_onelist::第二个（True|False）根据文档副标题进行渲染
第三个（True|False）根据文件名和行号渲染段落（如todo-list中的sphinxext.todo）
安装我
easy_install
easy_install sphinxcontrib-gen_node
pip
pip install Sphinx pip sphinxcontrib-gen_node
zc.buildout
eggs =
Sphinx
sphinxcontrib-gen_node
更新您的源/conf.py
extensions = ['sphinxcontrib.gen_node']
gen_nodes = [('sample_one', True, True, False), ('sample_two', True, False, False)]
致谢
公司
更新日志
0.1 (2013-10-31)
Jean-Philippe Camguilhem <jean-philippe.camguilhem__at__makina-corpus.com>
贡献者
Jean-Philippe Camguilhem，作者
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关 安装软件包 的更多信息。
源代码发行版
sphinxcontrib-gen_node-0.1-20131031.zip (12.0 kB 查看哈希值)
关闭
sphinxcontrib-gen_node-0.1-20131031.zip 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 4f4d6e62facbe81a28d33ec06b3685679d2302ee4b66b84af85a487ed1568187 |
|
| MD5 | 2c2bb8082737b78088799f0867550223 |
|
| BLAKE2b-256 | e6fe9e3d354cfb43e0a52f0dbe830faf6ec710b66d97a0c862dfb1ad78d8bdb9 |
