标签：python-sphinx
-
如何在reStructuredText简单表中使列内容右对齐？ - python
我正在使用Sphinx编辑我的项目的文档，该文档又使用reStructuredText作为标记语言。 我有一个简单的表(而不是网格表)，其中最右边的列报告包含我想右对齐的数字，但是我找不到如何实现的。 ============ ===================== Event Score variation ============ ========= […]
-
使用Python-Sphinx解析Javadoc - java
我使用部分包含Java和Python代码的共享存储库。代码基础主要基于python，但是一些库是用Java编写的。 是否可以解析或预处理Java文档以便使用以后在Python-Sphinx甚至插件中使用？ 参考方案 javadoc命令允许您编写和使用自己的doclet类以选择的任何形式生成文档。输出不需要直接为人类所理解...因此，没有什么可以阻止您以Sph […]
-
从sphinx autodoc发出reStructuredText吗？ - python
CPython的文档不使用自动文档-我们使用手写的散文。 对于PEP 3144(ipaddress模块)，我想使用sphinx-apidoc生成初始参考文档。这意味着我要运行两次通过操作: 使用sphinx-apidoc为依赖于autodoc的模块发出Sphinx项目 运行一个狮身人面像生成器，该生成器创建新的reStructuredText源文件，所有 […]
-
如何使用Sphinx记录简单的Python脚本？ - python
我已经阅读了许多Sphinx教程，但是我仍然不知道如何使Sphinx文档成为像这样的简单Python脚本： def addNumbers(a): """This function adds one to the given number. :param a: The name to use :type a: int " […]
-
如何在Sphinx文档中自动添加参数类型 - python
我目前正在尝试使用Sphinx实现自动文档创建（使用扩展名sphinx-apidoc和napoleon）。这很好用，但是如果将typehints（PEP484约定）自动添加到params列表中会更好。 我想知道这是否可能。 更具体地说：（来自napoleon example） def function_with_pep484_type_annotations […]