python – 将命令行工具的使用帮助添加到README.rst

由于我很懒,我想让更新程序尽可能简单.以下是我想要的更新工作流程：

>更新导致更新使用消息的代码.
>运行更新文档的脚本：新的用法消息应该在文档中可见.

换句话说：我不想复制粘贴用法消息.

Step1来自我自己的大脑.但是想要重用Step2的现有工具.

到目前为止,文档只是一个简单的README.rst文件.

我想坚持使用一个简单的解决方案,通过github可以直接看到文档.到目前为止,我不需要更复杂的解决方案(如readthedocs).

如何避免复制粘贴–help用法消息？

这是我正在使用的工具：https://github.com/guettli/reprec

例如,创建一个RST“模板”文件：

README.rst.tmpl

Test Git pre-commit hook project
--------------------------------

>>> INSERTION POINT FOR HELP OUTPUT <<<

的.git /钩/预提交

# Sensible to set -e to ensure we exit if anything fails
set -e

# Get the output from your tool.
# Paths are relative to the root of the repo
output=$(tools/my-cmd-line-tool --help)

cat README.rst.tmpl |
while read line
do
  if [[ $line == ">>> INSERTION POINT FOR HELP OUTPUT <<<" ]]
  then
    echo "$output"
  else
    echo "$line"
  fi
done > README.rst
git add README.rst

如果您未在命令行上传递提交消息,则会在提示您输入提交消息之前运行此命令.因此,如果对README.rst.tmpl或工具的输出进行任何更改时进行提交,则README.rst将使用它进行更新.

编辑

我相信这也适用于Windows,或类似的东西,因为git在Windows上带有bash实现,但我还没有测试过.