Sphinx扩展，可自动记录click应用程序
项目描述
sphinx-click 是一个 Sphinx 插件，允许您从基于 Click 的应用程序中自动提取文档，并将其包含在您的文档中。
安装
使用 pip 安装插件
$ pip install sphinx-click或者，通过克隆此存储库然后在本地上运行 pip 来从源安装
$ pip install .使用方法
在您的Sphinx conf.py 文件中启用插件
extensions = ['sphinx_click']启用后，您现在可以在文档的任何必要位置使用此插件。
.. click:: module:parser
:prog: hello-world
:nested: full在 文档 中提供了有关各种选项的详细信息。
代替
此插件非常适合在 Sphinx 中记录基于点击的 CLI，因为它可以正确地以美观的 HTML 格式渲染帮助屏幕及其选项，并包含深链接和样式。
然而，如果您想记录基于点击的 CLI 的源代码及其执行结果，您可能想查看 click-extra。后者提供了 .. click:example:: 和 .. click:run:: Sphinx 指令，以便您可以在文档中 捕获和渲染 CLI 的结果，并带有完整的颜色。
下载文件
下载您平台的文件。如果您不确定选择哪一个，请了解更多关于 安装包 的信息。
源代码分发
sphinx_click-6.0.0.tar.gz (29.6 kB 查看散列)
构建分发
sphinx_click-6.0.0-py3-none-any.whl (9.9 kB 查看散列)
关闭
sphinx_click-6.0.0.tar.gz 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | f5d664321dc0c6622ff019f1e1c84e58ce0cecfddeb510e004cf60c2a3ab465b |
|
| MD5 | 55e1d13d1c64fa7e3fe0f1ca60459c02 |
|
| BLAKE2b-256 | db0a5b1e8d0579dbb4ca8114e456ca4a68020bfe8e15c7001f3856be4929ab83 |
关闭
sphinx_click-6.0.0-py3-none-any.whl 的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | 1e0a3c83bcb7c55497751b19d07ebe56b5d7b85eb76dd399cf9061b497adc317 |
|
| MD5 | 57766de15c0a743f77d69479e4cc1ce9 |
|
| BLAKE2b-256 | d0d78621c4726ad3f788a1db4c0c409044b16edc563f5c9542807b3724037555 |
