Distutils命令，用于查看和验证包的长描述中的reStructuredText
项目描述
collective.checkdocs向distutils添加了新的命令checkdocs和showdocs，用于验证Python eggs的长描述字段中的reStructuredText。此包旨在使Python egg的帮助页面发布和编辑更加容易。
egg的长描述字段，通常也是包的README.txt文件，是reST格式化的文本。当包在PyPI或plone.org等分发存储库发布时，此文本将转换为HTML以在包页面上显示。不幸的是，由于存储库在验证传入的reST文本方面做得不好，文本中的错误将导致发布的包页面损坏。
取消发布通常非常麻烦。我们通过在提交egg到PyPi之前使用checkdocs和showdocs命令来验证reST输入来节省我们的时间。
安装
将其安装到您的开发Python运行时
easy_install collective.checkdocs
注意：在OSX上至少需要Python 2.5或更高版本。
新命令
以下命令将添加到所有setup.py安装程序中。
checkdocs
将long_description通过reST到HTML转换器转换，并将错误和警告打印到标准输出。
任何错误或警告都将导致distutils中止。
示例
python setup.py checkdocs <string>:4: (WARNING/2) Inline literal start-string without end-string. error: long_description had reST syntax errors
showdocs
将long_description通过reST到HTML转换器转换，并在本地网页浏览器中显示结果。在按CTRL+C之前，在端口6969上运行网络服务器。
示例
python setup.py showdocs running showdocs reST to HTML conversion available at at https://127.0.0.1:6969/ - press CTRL+C to interrupt
源代码
资源
long_description文本是reStructuredText格式
关闭
集体.checkdocs-0.2.zip的哈希
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 3a5328257c5224bc72753820c182910d7fb336bc1dba5e09113d48566655e46e |
|
| MD5 | 472a6c7cafad4ee274c905ebd1603fb3 |
|
| BLAKE2b-256 | b33b2d3f1d3685ae820f0f7076d098a51d6c65493d086f0101556e8cc28bbb86 |