Python Sphinx-获取不带签名的函数文档
我有一个用Sphinx编写的python脚本。脚本的一个输入是一个文本文件,我在一个单独的函数中解析它,比如说Python Sphinx-获取不带签名的函数文档,python,python-sphinx,autodoc,Python,Python Sphinx,Autodoc,我有一个用Sphinx编写的python脚本。脚本的一个输入是一个文本文件,我在一个单独的函数中解析它,比如说parse_file(f)。parse_file的docstring就是记录此文本格式的地方。我使用文档记录命令行参数。我的RST看起来像这样: .. argparse:: :module: mypkg.my_script :func: get_parser :prog: my_bash_wrapper.sh .. autofunction:: mypkg.my
parse_file(f)
。parse_file
的docstring就是记录此文本格式的地方。我使用文档记录命令行参数。我的RST看起来像这样:
.. argparse::
:module: mypkg.my_script
:func: get_parser
:prog: my_bash_wrapper.sh
.. autofunction:: mypkg.my_script.parse_file
我几乎得到了我想要的,但是很明显,这个函数在文档中有一个签名,但是我的命令行用户不会在意这一点。我查看了autodoc文档,有很多方法可以将签名重写为其他签名,但似乎都需要一些实际内容,而不是空字符串。我似乎找不到没有签名的方法
有人知道我想要什么吗?或者我必须把docstring函数放在sphinx中吗?提前谢谢