我有一个python脚本,我正在使用Sphinx进行记录。脚本的一个输入是一个文本文件,我在一个单独的函数中解析,比方说parse_file(f)
。 parse_file
的文档字符串是记录此文本格式的位置。我使用sphinx-argparse记录命令行参数。所以我的RST看起来像这样:
.. argparse::
:module: mypkg.my_script
:func: get_parser
:prog: my_bash_wrapper.sh
.. autofunction:: mypkg.my_script.parse_file
我几乎得到了我想要的东西,但显然该函数在文档中有签名,但我的命令行用户不关心这一点。我查看了autodoc文档,有很多方法可以将签名覆盖到其他签名,但似乎都需要一些实际内容而不是空字符串。我似乎无法找到一种没有签名的方式。
有没有人知道如何获得我想要的东西或者我必须求助于将函数docstring放在sphinx中?提前谢谢。