Python
Java
PHP
IOS
Android
Nodejs
JavaScript
Html5
Windows
Ubuntu
Linux
如何交叉引用 Sphinx 中 autodoc 生成的函数?
我正在使用Sphinx autodoc根据我的 Python 库的文档字符串生成文档的功能 找到交叉引用的语法here http sphinx doc org markup inline html ref role 该部分之前必须有一个标签
python
Methods
pythonsphinx
reStructuredText
autodoc
Sphinx 文档中人类可读的迭代
Sphinx autodoc 扁平化字典 列表和元组 使得长的几乎难以阅读 漂亮的打印格式也并不总是需要的 因为一些嵌套容器最好保持扁平化而不是列化 有没有办法显示可迭代对象as typed在源代码中 直接从源获取它 并添加一个 rst其命
pythonsphinx
reStructuredText
autodoc
如何在 Sphinx 文档中将成员注释为抽象?
以下两个属性定义在 Sphinx 中显示完全相同autodocHTML 输出 property def concrete self This is the concrete docstring pass abstractproperty d
python
pythonsphinx
pythondecorators
autodoc
ABC
Sphinx automodule:如何引用同一模块中的类?
我正在尝试使用狮身人面像autodoc http www sphinx doc org en master usage extensions autodoc html扩展 特别是automodule指令自动为我正在开发的 django 应用
python
django
pythonsphinx
autodoc
autodoc 扩展模拟类的类
我正在尝试在扩展外部类的类上运行 autodoc 我使用了模拟以便接受导入 为此 我使用了本博客中描述的内容http blog rtwilson com how to make your sphinx documentation compi
python27
mocking
pythonsphinx
autodoc
未知的指令类型“toctree”。 Pycharm 出错,但 index.html 有效
在 PyCharm 中工作时 我在 Sphinx 中创建的文档的预览模式显示 System Message ERROR 3
pycharm
pythonsphinx
preview
autodoc
toctree
sphinx autodoc包含子功能
我想在 sphinx 文档中自动包含函数的子函数 有什么选择呢 我的代码看起来像 import numpy def mainfunc to be documented def subfunc to be documented as well
python
pythonsphinx
autodoc
Sphinx 是否可以处理不能很好导入的代码?
Sphinx 文档引擎能否成功生成导入不佳的项目的文档 特别是我的项目有一种奇异的依赖性 我不希望文档生成依赖于这种依赖性 Sphinx 是否需要导入我的模块并使用内省或解析 如果您使用 autodoc 扩展 那么您的项目必须是可导入的 但
python
pythonsphinx
autodoc
如何在 Sphinx 文档中显示类的继承成员?
我想记录一些类 这些类都派生自具有一些公共属性的同一基类 并且我想重复子类中每个属性的文档 以便我可以在一个位置看到一个类的所有属性 例如我有这样的代码 class Base object Base class First attribut
pythonsphinx
autodoc
sphinx-build 失败 - autodoc 无法导入/查找模块
我正在尝试开始使用 Sphinx 但似乎遇到了无情的问题 命令 docs sphinx quickstart 我回答了所有问题 一切正常 命令 docs ls 一切看起来都很正常 结果 build Makefile source 命令 sp
python
pythonsphinx
autodoc
缩短Sphinx中Python类型注释的显示格式
在名为的模块中给出以下函数mymodule我想使用 Sphinx 来记录autodoc from typing import Union from collections abc import Iterable from numpy typ
python
pythonsphinx
typehinting
autodoc
Python autodoc 元组/列表格式可以更改吗?
我想在项目中记录一些 Python 代码 但是在记录元组或列表类常量时遇到了问题 请参阅下面的代码和图像 当每行有多个项目并且行被随机分割时 阅读文档非常困难 元组可以用其他方式格式化吗 就像新行上的每个元素一样 我仍然想使用 autodo
python
pythonsphinx
autodoc
Swagger-PHP 用于为 Swagger-UI 生成 JSON 文件
我正在尝试使用 Swagger PHP 生成 JSON 文件 以便我可以将它与 Swagger UI 一起使用来自动记录文档 我尝试了链接 https github com zircote swagger php https github
php
json
swagger
autodoc
Sphinx:如何排除自动模块中的导入?
我有一个用 Python 编写的 Raspberry Pi 项目 它使用 RPi GPIO 模块 代码上的所有工作都是在 Windows 机器上完成的 其中 RPi GPIO 不会安装 每次我尝试运行 autodoc 时 它都会崩溃 说它无
pythonsphinx
ImportError
GPIO
autodoc
如何使用 autodoc 覆盖 Sphinx 中的构造函数参数?
假设我有一堂这样的课 class MyClass object Summary docs for my class Extended documentation for my class def init self args self va
python
pythonsphinx
autodoc
如何使用 Sphinx 记录特定部分中的成员?
我正在努力弄清楚如何将 Python 类的特定成员的文档放置在 Sphinx 文档的特定部分中 理想情况下 同时在另一个部分中自动记录其余部分 我有一个Python课程 class MyClass object def funky self
python
python27
Documentation
pythonsphinx
autodoc
Sphinx 找不到我的 python 文件。说“没有名为...的模块”
我有一个关于 Sphinx 自动文档生成的问题 我觉得我想做的事情应该很简单 但由于某种原因 它不起作用 我有一个Python项目 其目录名为slotting tool 该目录位于C Users Sam Desktop picnic dat
python
python3x
pythonsphinx
autodoc
在 sphinx-apidoc 生成的文件中包含 __main__.py
我无法在生成 RST 文件时正确添加 main py 文件及其功能sphinx apidoc 其他文件和类均正确生成 仅当我运行 sphinx apidoc 时我才工作 P包含私有模块的参数 但我不想添加其他模块的私有方法 我只需要 mai
python
pythonsphinx
autodoc
sphinxapidoc
如何在 Sphinx 中的方法内自动编写函数
代码示例 class A object def do something self doc a def inside function doc b pass pass I tried autoclass A autofunction A d
python
scope
pythonsphinx
reStructuredText
autodoc
阅读文档 Sphinx 版本中不包含文档字符串
我构建了 Sphinx 文档 并且该构建在本地运行良好 我的文档字符串如下所示 当移动到 readthedoc io 时 我在下面添加了一个特定的要求文件docs requirement txt这是 sphinx 3 5 4 sphinx
python
pythonsphinx
ReadTheDocs
autodoc
1
2
»