Sphinx指令，用于添加不可选提示
项目描述
Sphinx Prompt
初始化
在conf.py中添加extensions += ['sphinx_prompt']。
语法
可以使用prompt指令创建一个默认提示
.. prompt::
<statements>
提示可以通过以下两种方式之一进一步自定义
-
使用位置参数
.. prompt:: [<language> [<prompts> [<modifiers>]]] <statements>
-
使用选项
.. prompt:: :language: <language> :prompts: <prompts> :modifiers: <modifiers> <statements>
虽然这些结构生成相同的输出，但在需要使用包含空格的提示时，不能使用位置参数。这是reStructuredText的限制。
如果它们不重叠，则可以将位置参数与选项混合使用（因此，如果您通过选项传递提示，则只能使用位置参数传递语言）
.. prompt:: bash
:prompts: (cool_project) $
python3 -m pip install --upgrade sphinx-prompt
语言
支持的语言
text（无颜料，默认）bashbatchpowershellpythonscala
提示
如果修改符为auto，则是在语句中查找的提示的逗号分隔列表。
否则是在每个语句上添加的提示，对于Python和Bash语言，支持末尾的\。
默认为空，除非以下列出的shell语言
bash-$batch-C:\>powershell-PS C:\>
示例
见：http://sbrunner.github.io/sphinx-prompt/
运行测试和prospector
python3 -m pip install --user --upgrade poetry
poetry install
poetry run pytest
poetry run prospector
代码应该使用black和isort格式化。
创建新版本
git tag <version>
git push origin <version>
贡献
安装pre-commit钩子
pip install pre-commit
pre-commit install --allow-missing-config
关闭
sphinx_prompt-1.9.0.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 471b3c6d466dce780a9b167d9541865fd4e9a80ed46e31b06a52a0529ae995a1 |
|
| MD5 | 6f8924cb64c87692974d29fbef2a254d |
|
| BLAKE2b-256 | 34feac4e24f35b5148b31ac717ae7dcc7a2f7ec56eb729e22c7252ed8ad2d9a5 |
关闭
sphinx_prompt-1.9.0-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | fd731446c03f043d1ff6df9f22414495b23067c67011cc21658ea8d36b3575fc |
|
| MD5 | ff01f7158a91e127e93a92a6eb93e6f4 |
|
| BLAKE2b-256 | 7698e90ca466e0ede452d3e5a8d92b8fb68db6de269856e019ed9cab69440522 |
