Sphinx在没有signatu的情况下获取函数文档

2024-05-18 12:34:43 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个python脚本,我正在用Sphinx编写文档。脚本的输入之一是我在一个单独的函数中解析的文本文件,比如parse_file(f)parse_file的docstring是记录此文本格式的地方。我使用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中吗?提前谢谢。在


Tags: 方法函数命令行文档脚本parsemysphinx

热门问题