它也会理解 numpydoc 和 Google 风格的字符串。 完美的继承 pdoc 会通过继承来解析类型注解和 docstrings。...random" 参考资料 [1] 官方文档: https://pdoc.dev/docs/pdoc.html [2] numpydoc: https://www.osgeo.cn/numpy/docs
建议使用numpydoc的风格:https://numpydoc.readthedocs.io/en/latest/format.html GitHub上的ReadMe文档。
NumPy 文档可以从以下网站获取: numpydoc on PyPI numpydoc on GitHub 请注意,对于 NumPy 内部的文档,在示例开头无需执行 import numpy...### 文档字符串 当使用 Sphinx 与 NumPy 约定结合时,应使用 numpydoc 扩展,以便正确处理您的文档字符串。...它可从以下位置获取: numpydoc on PyPI numpydoc on GitHub 请注意,对于 NumPy 内的文档,不需要在示例开头执行 import numpy as np。...文档字符串 当将Sphinx与 NumPy 约定结合使用时,应使用numpydoc扩展,以使您的文档字符串被正确处理。...可从以下网址获取: PyPI 上的 numpydoc GitHub 上的 numpydoc 请注意,在 NumPy 文档中,不需要在示例开头执行import numpy as np。
numpydoc_class_members_toctree = False # 匹配引用的正则表达式,应该被修改以避免在文档中重复。默认为[\w-]+。...numpydoc_citation_re = r"[\w-]+" # 在版本0.8之前,参数定义显示为块引用,而不是在定义列表中。如果您的样式需要块引用,请将此配置选项切换为True。...numpydoc_xref_param_type = False # 完全限定路径的映射(或正确的ReST引用),用于指定参数类型时使用的别名/快捷方式。键不应包含任何空格。...此选项取决于numpydoc_xref_param_type选项为True。 numpydoc_xref_aliases = {} # 定义一个集合,用于存储不需要交叉引用的单词。...numpydoc_xref_ignore = set([]) # 是否在文档字符串后插入编辑链接。已弃用自版本编辑:您的HTML模板。
conda-forge 1.0.6 py34_0 conda-forge numpydoc
@end """ 除了可以在@widgets和@end块中指定参数的描述文本,PyGUIAdapter还会从 ReST、Google、Numpydoc-style以及Epydoc风格的文档注释中提取参数的描述信息
py27_0 conda-forge 1.0.6 py34_0 conda-forge numpydoc
4.4.0=py36_0 - ncurses=6.0=hd04f020_2 - notebook=5.4.1=py36_0 - numpy=1.14.2=py36ha9ae307_1 - numpydoc
"name": "numpy-base", "version": "1.16.5-py27hde5b4d6_0" }, { "name": "numpydoc...name": "numpy-base", "version": "1.18.5-py38hde5b4d6_0qnlpvflb" }, { "name": "numpydoc...", "version": "1.1.0-py_0" }, { "name": "numpydoc", "version": "1.1.0-py
numexpr=2.7.0=py37hdce8814_0 - numpy=1.16.5=py37h19fb1c0_0 - numpy-base=1.16.5=py37hc3f5095_0 - numpydoc
我们还使用 numpydoc 来呈现生成的 API 文档中的 docstrings。SciPy 已安装,因为文档的某些部分需要使用 SciPy 函数。...我们还使用numpydoc在生成的 API 文档中呈现 docstrings。由于某些文档部分需要 SciPy 函数,因此还安装了SciPy。 要安装Doxygen,请参阅官方下载和安装页面。...我们还使用numpydoc在生成的 API 文档中呈现 docstrings。由于某些文档部分需要 SciPy 函数,因此还安装了SciPy。
_typing中的类型 #21245: 维护:为 CI 文档构建指定 sphinx、numpydoc 版本 #21275: 错误:修复拼写错误 #21277: 增强、构建:修复 wasm..._typing 中的类型 #21245: 维护:为 CI 文档构建指定 sphinx、numpydoc 版本 #21275: BUG:修复拼写错误 #21277: ENH, BLD:修复
1.18.1 py37h7241aed_0 numpy-base 1.18.1 py37h3304bdc_1 numpydoc
领取专属 10元无门槛券
手把手带您无忧上云