python - Sphinx 模块文档字符串命令行参数/Argparse

Question

模块命令行参数的标准 sphinx 文档字符串格式是什么？例如：

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-f', '--file', default=f'{PATH}/data/', help='excel spreadsheet')
    args = parser.parse_args()
    main(args.file)

我宁愿手动记录这一点，也不愿使用 sphinx argparse 扩展。我考虑过对模块文档字符串使用下面的方法，但我现在不考虑它是否是标准方法，也不考虑如何指示-f标志。此外，我实际上使用的是 numpy 样式的文档字符串，但我将标准 sphinx 格式留在这里，以便更多人能够理解它。

:param file: excel spreadsheet
:ptype file: str