遵循git-pull python包规范的项目的内部工具
项目描述
gp-libs · 
在git-pull项目上孵化/ 自食其力 一些sphinx扩展和pytest插件，例如 cihai，vcs-python 或 tmux-python。
doctest 用于reStructured和markdown
两个组件
-
doctest_docutils模块：与doctest相同的规范，但可以解析reStructuredText和markdown -
pytest_doctest_docutils：Pytest插件，为pytest收集reStructuredText和markdown文件的测试项这意味着您可以这样做
$ pytest docs
doctest模块
这扩展了标准库doctest以支持docutils可以解析的任何内容。它可以解析reStructuredText (.rst) 和markdown (.md)。
查看更多：https://gp-libs.git-pull.com/doctest/
支持的风格
它支持两个基本的指令
-
docutils的
doctest_block>>> 2 + 2 4
-
.. doctest::指令reStructuredText
.. doctest:: >>> 2 + 2 4
Markdown（需要myst-parser）
```{doctest} >>> 2 + 2 4 ```
用法
doctest_docutils模块保留了标准库的使用约定
reStructuredText
$ python -m doctest_docutils README.rst -v
这正是doctest的设计目的。
Markdown
如果您安装了myst-parser，doctest将在.md文件上运行。
$ python -m doctest_docutils README.md -v
pytest插件
此插件禁用了pytest的标准doctest插件。
此插件与pytest的doctest_docutils模块集成，以实现文档、conftest.py固件等的无缝测试。
$ pytest docs/
与上述模块类似，它支持docutils自己的doctest_block和一个基本的.. doctest::指令。
查看更多：https://gp-libs.git-pull.com/doctest/pytest.html
sphinx插件
纯文本问题链接器（linkify-issues）
我们需要解析纯文本，例如#99999，指向https://github.com/git-pull/gp-libs/issues/99999的项目跟踪器。这样，Markdown在任何渲染的地方看起来都很好，包括GitHub和GitLab。
配置
在您的conf.py
-
将
'linkify_issues'添加到extensionsextensions = [ # ... "linkify_issues", ]
-
配置您的Issue URL，
issue_url_tpl# linkify_issues issue_url_tpl = 'https://github.com/git-pull/gp-libs/issues/{issue_id}'
配置变量是通过{meth}
str.format格式化的，其中issue_id是如果文本是#42，则为42。
查看更多：https://gp-libs.git-pull.com/linkify_issues/
安装
$ pip install --user gp-libs
开发版本
您可以在g发布之前测试未发布的版本。
-
pip:
$ pip install --user --upgrade --pre gp-libs
最低要求
为了减轻支持旧版API的开发负担，因为这个包使用较少，已经固定了最小约束
- docutils: 0.20.1+
- myst-parser: 2.0.0+
如果您对支持旧版版本有哪怕是一点点兴趣，请在跟踪器上提交一个问题。
更多信息
- Python支持：>= 3.8, pypy
- 源：https://github.com/git-pull/gp-libs
- 文档：https://gp-libs.git-pull.com
- 变更日志：https://gp-libs.git-pull.com/history.html
- 问题：https://github.com/git-pull/gp-libs/issues
- 测试覆盖率：https://codecov.io/gh/git-pull/gp-libs
- pypi：https://pypi.python.org/pypi/gp-libs
- 许可：MIT。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。