问题背景:我想在我的django项目中使用sphinx编写文档，并使用我的django代码注释自动创建文档。现在我有一个django(1.9)项目，文件结构如下:myproject/myproject/__init__.pysettings.pyurls.pywsgi.pymyapp/migrations/__init__.pyadmin.pymodels.pytests.pyviews.pydocs/_build/_static/_templates/conf.pyindex.rstMakefile然后，如您所见，我放置了一个docs文件夹，其中包含一个Sphinx文档项目。现在我可
这个问题在这里已经有了答案:Sphinx--combiningautomoduleandautoclass(2个答案)关闭2年前。我尝试使用sphinx及其autodoc插件为包含数千个类的项目创建html文档。sphinx-apidoc创建精彩的初始文件，但缺少自动创建autoclasses和automethods。sphinx中是否有一种方法/命令/实用程序可以在文档中自动包含所有变量、函数、类和装饰器？第一个文件的一些示例代码:taggerPackage=================:mod:`tagger`Package------------------------..a
我正在使用Sphinxautodoc扩展来记录模块，我想在文档输出中获取模块成员的平面列表。我尝试使用以下方法:..automodule::modname:members:但是，这有两个问题:它包括模块的文档字符串，我不在这里想要它。每个条目的名称都以“modname.”为前缀，这是完全多余的(因为此页面专门用于记录此模块)但是，我找不到任何配置选项可以让我有选择地禁用这两个方面，同时仍然获得所有模块成员的自动列表。我目前的计划是只使用自动函数(等)并显式枚举要记录的成员，但我仍然想知道我是否错过了实现我最初想要的东西的简单方法。更新:我至少找到了第二部分的解决方法:在conf.py中
我有以下包结构作为最小示例(为方便起见，全部上传here):.├──sphinx│ ├──build│ ├──Makefile│ └──source│ ├──conf.py│ ├──index.rst│ └──train.rst└──train├──__init__.py└──train.py编写Python包时，必须在任何包的__init__.py中指定__all__常量，以便Sphinx能够映射引用，例如train.DatasetMeta到train.train.DatasetMeta或类似的。但是，sphinx-apidoc为这些包生成以下部分:trainpackag
我想将我项目的README.md包含到我的Sphinx文档中，如Cansphinxlinktodocumentsthatarenotlocatedindirectoriesbelowtherootdocument?-在生成的Sphinxhtml文档中，我单击欢迎页面目录中的链接并转到README.md。为此，创建了一个文档readme_link.rst，其中包含以下行ReadmeFile-----------..include::../../README.md然后我添加行README进入index.rst目录树。随之而来的是，我的README.md没有被解析为Markdown，而是按原
我正在使用Sphinx记录我的一个项目，我喜欢在浏览器中预览我的更改。我希望能够将一些更改保存到.rst文件，并能够立即刷新我的浏览器并查看更改。本质上，只要其中一个.rst文件发生更改，我就想自动执行makehtml。 最佳答案 您可以使用sphinx-autobuild.使用方便，例如:sphinx-autobuilddocsdocs/_build/html或者，如果您有单独的构建目录，sphinx-autobuildsourcebuild/html它还会在浏览器中自动启动页面刷新。
问题在尝试为可重复使用的Django应用程序生成sphinx文档时，我偶然发现了以下snafoo。当sphinx解析model.py它被其中的代码试图访问Djangoproject设置所阻止。由于这是一个独立/可重复使用的应用程序，因此没有提供这些设置的主要项目，即没有ROOT/PROJECT/PROJECT/settings.py。文件。设置为了清楚起见，这里是我所做的。遍历通常的项目文件夹cdROOT/PROJECT并创建一个应用程序django-adminstartappAPPLICATION产生以下结构/ROOT//PROJECT//APPLICATION/admin.pyap
我正在尝试清理我的python代码文档，并决定使用sphinx-doc因为它看起来不错。我喜欢使用如下标签引用其他类和方法::class:`mymodule.MyClass`Aboutmyclass.:meth:`mymodule.MyClass.myfunction`Andmycoolfunction我正在尝试弄清楚如何在函数中记录参数名称，这样如果我有这样的函数:defdo_this(parameter1,parameter2):"""Icandescribedo_this.:something?:`parameter1`Andthendescribetheparameter.""
在我的Sphinx文档中，当我在重组的文本中引用它们时，我想显示键盘键的图片。例如，如果我说:按Enter键。我想在线显示Enter键的图片，而不仅仅是Enter一词。我在许多教程中看到过这种图形，用于指代键盘键、菜单选项等。他们是怎么做到的？我可以在Sphinx中执行此操作吗？ 最佳答案 首先考虑使用语义标记来提高可访问性。Sphinx可以渲染角色:kbd:,:menuselection:,或:guilabel:到HTML或PDF。对于HTML输出，然后您可以应用CSS使按键笔画完全按照您的意愿显示，甚至可以让它们看起来像图像而不
使用SphinxforPython如何避免所有方法/函数名称在HTML中按字母顺序排序？我希望它们的顺序与它们在源代码中的顺序完全相同。 最佳答案 来自sphinx.ext.autodocdocumentation:autodoc_member_orderThisvalueselectsifautomaticallydocumentedmembersaresortedalphabetical(value'alphabetical'),bymembertype(value'groupwise')orbysourceorder(valu
