Sphinx RestructedText builder

bfabio.sphinx-rst-builder的Python项目详细描述


Sphinx RestructedText Builder

生成reST(reStructuredText)文件的扩展名。在

此扩展在与autodoc结合使用时特别有用 自动生成文档以供任何rst解析器使用的扩展 (例如GitHub wiki)。在

就其本身而言,扩展相当简单——它需要解析的其余部分 来自Sphinx的文件并将其作为reST输出。在

要求

  • Sphinx2.0或更高版本
  • Python 3.6或更高版本

安装

使用pip

pip install sphinx-rst-builder

手动
git clone https://github.com/davidfritzsche/sphinx-rst-builder.git cd sphinx-rst-builder python setup.py install

如果您想看一看并尝试一下,可以将reST构建器放入其中 一个扩展子目录,并调整sys.path来告诉Sphinx要去哪里 寻找它:

  • 将扩展目录添加到conf.py中的路径。E、 g

用法

  • conf.py中将生成器设置为扩展:
  • 使用目标rst运行sphinx build:

配置

以下四个配置变量由定义sphinxcontrib.restbuilder公司名称:

rst_file_suffix

This is the file name suffix for generated reST files. The default is ^{tt6}$.

rst_link_suffix

Suffix for generated links to reST files. The default is whatever ^{tt5}$ is set to.

rst_file_transform

Function to translate a docname to a filename. By default, returns docname + ^{tt5}$.

rst_link_transform

Function to translate a docname to a (partial) URI. By default, returns docname + ^{tt7}$.

进一步阅读

反馈

reST生成器处于初始状态。它还没有被广泛使用,所以 任何反馈都是特别受欢迎的。在

变更日志

斯芬克斯rst builder 0.0.1(2019年6月21日)

restbuilder 0.2(2018年6月7日)

restbuilder 0.1(2013年8月25日)

restbuilder(无版本)(2012年4月28日)

BSD-2条款许可证

版权所有(c)2019,作者:David Fritzsche和贡献者。在

以源代码和二进制形式重新分发和使用,有无 允许修改,前提是下列条件 会议:

  • 源代码的再分配必须保留上述版权 注意,此条件列表和以下免责声明。在
  • 二进制形式的再分配必须复制上述版权 注意,此条件列表和以下免责声明 分发时提供的文件和/或其他材料。在

本软件由版权所有人和贡献者提供 “原样”和任何明示或暗示的保证,包括但不 仅限于对适销性和适用性的默示保证 一个特殊的目的被否认。在任何情况下,版权 所有人或出资人对任何直接的、间接的、偶然的, 特殊、惩戒性或后果性损害(包括但不包括 仅限于采购替代货物或服务;丧失使用, 数据或利润;或业务中断) 责任理论,无论是合同、严格责任还是侵权 (包括疏忽或其他原因)在使用过程中产生的 即使被告知有这种损坏的可能性。在

贡献者

Freek Dijkstra(麦克弗里克) G、 尼古拉斯d“安德烈(格尼丹) 杰弗里·罗(杰弗里·罗) 马修·普朗查德 尼古拉·穆萨蒂(nmusatti) 大卫弗里茨切(大卫弗里茨切)

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
如何使用Java获取“特定id XML数据”   用于在GET方法中筛选对象的java可选属性   简单的Java文件传输程序问题   JavaSpringMVC无法显示静态资源   java如何在javadoc示例中编写块注释?   java My程序在MergeSort数组中不能正确计数反转   Java Mail API电子邮件未按相反顺序显示   Java FX示例在NetBeans中打开时抛出错误   java递归在游戏配置单元中搜索蜘蛛实现的一个分支后停止   java selenium webdriver行为:是挂起还是什么?   JAVAawt。机器人鼠标垫没有任何效果   java试图让用户按enter键生成下一个素数   java在Android SQLite应用程序中没有这样的表,有2个表   java Elasticsearch RestClient连接由对等方重置   java如何设置log4j2 asyncQueueFullPolicy   elasticsearch java中的elasticsearch查询,用于检索特定字段中具有最少值的所有文档   java如何使用where子句从firestore中的集合中获取数据?   检测文件更改的java Eclipse侦听器?