autodoc - IT屋-程序员软件开发技术分享社区

Sphinx不识别子文件夹

我是新手Sphinx。只要我的文件在source顶层文件夹中，我就能够创建HTML文档。只要我将它们放到source directory中的子文件夹中，Sphinx就不会将文档包含到构建中。Sphinx在生成后告诉我测试文档不包括在内。因此，它可以看到该文件，但不包括它。我错过什么了吗？我是否必须在index.rst文件或config.py中指定任何子文件夹？我的index ..

在狮身人面像中更新文档字符串

我正在尝试为dask project的文档做出贡献。我想添加this issue中建议的pandas引用。我可以在我的开发人员计算机上重建文档，但在更新docstring时，我看不到文档中有任何更改。例如，我尝试添加:meth:pandas.{reader}以更新csv.py中的READ_DOC_TEMPLATE，但未进行任何更新。我尝试对docstring进行简单的更新(即更改文 ..

发布时间：2022-04-22 09:00:49 python python-sphinx autodoc Python

如何将：特殊成员：仅应用于自动模块指令中的一个类？

我正在使用autodoc和napoleon为一个Python2.7项目整理Sphinx驱动的(v1.3.1)文档。在我想用单个automodule::指令记录的一个模块中，我有一个要应用:special-members:标志的特定类。将automodule::标记为:special-members:会显示模块中所有的特价商品，这不太好。如何执行此操作？添加标记为:special-m ..

发布时间：2022-04-21 23:48:18 python python-sphinx autodoc sphinx-napoleon double-underscore Python

当使用Sphinx和AutoDoc来记录一个Python项目时，您可以使用:Example:在您的模块/类/函数文档字符串中包含一个代码样例，Sphinx将友好地为您突出显示它的语法。大概是这样的。 >>> rng = Range(0, 1000) >>> rng [0, 1000) >>> len(rng) 1000 >>> rng.start = 500 >>> rng.start 50 ..

发布时间：2022-04-21 22:59:29 python python-sphinx doctest autodoc Python

在ReadtheDocs上未呈现Python Sphinx自动文档

我在Github上托管了一个名为spike2py的Python包。我已经使用Sphinx和.rst文件准备了我的文档。这些文件托管在GitHubhere上。我能够在本地成功运行make html并获得所需的输出。也就是说，文档的参考指南部分包含使用我的代码中包含的文档字符串自动生成的API，并通过调用autoclass和autofunction(reference_guide.rst)来引用。 ..

发布时间：2022-04-21 15:56:39 python python-sphinx read-the-docs autodoc Python

如何在我的Sphinx文档中显示类的继承成员？

我想记录一些类，这些类都派生自具有一些公共属性的同一基类，并且我想重复子类中每个属性的文档，以便我可以在一个位置查看类的所有属性。例如，我有这样的代码： class Base(object): """Base class.""" #: First attribute a = int #: Second attribute b = str ..

发布时间：2022-04-21 14:12:53 python-sphinx autodoc 其他开发

文档字符串不包括在Read the Docs Sphinx版本中

我构建了一个Sphinx文档，该构建在本地运行得很好。我的文档字符串如下所示。移动到readthedoc.io时，我在docs/requirement.txt下添加了一个特定的需求文件，该文件是： sphinx==3.5.4 sphinx_rtd_theme==0.5.2 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1. ..

发布时间：2022-04-21 13:10:54 python python-sphinx read-the-docs autodoc Python

使用Sphinx'；AutoDoc仅显示私有方法

这里有几个关于使用AutoDoc显示私有方法的问题，但我没有看到任何关于仅显示私有方法的问题。私有方法和常规方法如下： .. autoclass:: my_package.my_file.MyClass :members: :private-members: 但是，删除:members:会导致无方法被显示。我如何才能仅显示私有方法，并且仅针对此指令？推 ..

发布时间：2022-04-21 12:11:15 python-sphinx autodoc 其他开发

Sphinx自动摘要：如何删除init的自动成员

问题我使用sphinx.ext.autosummary作为我的python包。问题是.. autosummary::始终添加.. automethod:: __init__，即使没有文档记录也是如此。同时，我找到了各种方法来第三次包含它(作为特殊成员)或将它包含在方法中；但我没有找到如何删除.. automethod:: __init__的方法。如图所示，这只是复制了上面的 ..

发布时间：2022-04-21 10:43:21 python python-sphinx autodoc Python

在Sphinx自动汇总指令中，这个"；生成"；选项是什么？

我正在使用sphinx-apidoc和autosumary扩展来记录某个库的API，但我真的无法理解以下generated/选项的用途： .. autosummary:: :nosignatures: :toctree: generated/ module.function_1 module.function_2 ... 我见过这是Sphinx文档，并且在 ..

发布时间：2022-04-21 09:57:20 python python-sphinx autodoc toctree Python

Sphinx错误：未知指令类型"；自动模块&或"；AutoClass"；

我需要使用Sphinx记录我的Python项目。但我无法使用autodoc。当我配置我的项目时，我选择了“扩展自动文档”选项，但现在如果我使用 .. autoclass:: Class 我收到一个错误： ERROR: Unknown directive type "autoclass" 我配置了PYTHONPATH，现在很好。但我已经有这个问题了。我的索引文件是 ..

发布时间：2022-04-20 23:22:43 python-sphinx autodoc 其他开发

Sphinx找不到特定目录中的模块

我在Python中遇到了一个关于Sphinx的问题。即使我按照https://groups.google.com/forum/#!topic/sphinx-users/lO4CeNJQWjg中的说明操作，我也无法解决它。我有Docs/SOURCE文件夹，其中包含： conf.py index.rst RstFiles(包含每个模块的.rst文件的文件夹)。在conf.py ..

发布时间：2022-04-20 23:14:36 python python-sphinx autodoc Python

在sphinx-apidoc生成的文件中包含main.py

我无法在使用sphinx-apidoc生成RST文件时正确添加我的__main__.py文件及其函数。其他文件和类已正确生成。仅当我使用-P参数运行sphinx-apidoc时才能工作，该参数包括私有模块。但我不想添加其他模块的私有方法，我只需要来自__main__.py的这些方法。 __main__.py如下所示： def main(): """ main() d ..

发布时间：2022-04-20 23:04:41 python python-sphinx autodoc sphinx-apidoc Python

在Sphinx中交叉引用Python对象有哪些要求？

我正在使用:class:，收到很多警告 WARNING: py:class reference target not found: mypkg.submodule.class。我在文档中找不到正确交叉引用的确切要求。这是我认为有以下要求的不完整列表：对象的模块需要是可导入的该对象需要存在于模块内部该对象需要使用:py:class::、:py:func::或类似 ..

发布时间：2022-04-20 22:56:23 python python-sphinx autodoc cross-reference Python

如何在嵌套目录中生成狮身人面像停靠？

我要从嵌套文件夹结构中的脚本生成Shinx AutoDoc文档： └── programs └── general_name └── another_folder ├── script1.py └── script2.py 由于某种原因，自动文档中没有显示script1.py和script2.py，我只能看到脚本名称 ..

发布时间：2022-04-20 22:24:52 python python-sphinx autodoc Python

拿破仑和奥多克如何互动记录成员

我注意到Sphinx呈现类描述的行为发生了变化。给定此代码 # my example happens to be a dataclass, but the behavior for # regular classes is the same @dataclass class TestClass: """This is a test class for dataclasses. ..

发布时间：2022-04-20 19:40:59 python python-sphinx autodoc python-dataclasses sphinx-napoleon Python

Swagger-PHP 用于为 Swagger-UI 生成 JSON 文件

我正在尝试使用 Swagger-PHP 生成 JSON 文件，以便我可以将它与 Swagger-UI 一起用于自动文档. 我尝试了链接:- https://github.com/zircote/swagger-php 我还尝试使用 http://zircote.com/swagger-php/installation.html 但我运气不好，我无法实现它. 我能够正确安装作 ..

发布时间：2022-01-22 18:20:39 php json swagger autodoc PHP

如何使用 Python-Sphinx 生成 HTML 文档?

我正在使用 PyCharm 开发一个 Python 项目，现在我需要生成相应的 API 文档.我正在使用 docstrings 记录代码方法和类.我读过关于 Sphinx 和 Doxygen 的文章，其中 Sphinx 是目前最推荐的.我尝试配置 Sphinx whitin PyCharm，但没有成功. 这是项目结构: 这是与命令 Sphinx Quickstart 的 I/O 交互 ..

发布时间：2022-01-08 09:29:02 python pycharm python-sphinx autodoc sphinx-apidoc Python

如何从 leiningen 项目中排除 jars?

在使用 Leiningen 时，我遇到了以下突然错误: 线程“main"中的异常 java.lang.NoSuchMethodError: org.apache.tools.ant.util.FileUtils.getFileUtils()Lorg/apache/tools/ant/util/FileUtils;(core.clj:1) 我在 https://github.com/te ..

发布时间：2022-01-02 23:19:29 clojure jar leiningen autodoc 其他开发

我如何在 Sphinx 中交叉引用由 autodoc 生成的函数?

我正在使用 Sphinx autodoc 功能根据我的 Python 库的文档字符串生成文档. 交叉引用的语法在这里标签必须位于该部分之前，以便可以从文档的其他区域引用该部分. 我拥有的是我的一个课程的 .rst (ReStructeredText) 文件.它使用 .. autoclass:: 类名:成员: 为类生成文档. 我的问题是，如何从文档中的另一个 .rst ..

发布时间：2021-12-23 08:58:10 python methods python-sphinx restructuredtext autodoc Python

autodoc相关内容