我有以下包结构作为最小示例(为方便起见，全部上传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
我正在为我的文档使用“阅读文档”Sphinx主题。在原题中，给出如下http://read-the-docs.readthedocs.org/en/latest/theme.html内容或主要布局宽度设计为适合移动设备。但是，对于我的项目，我希望它更宽一些。我不懂HTML，因此如果有人能给我一些增加内容(布局)宽度的线索，我将不胜感激。 最佳答案 另一种选择是在source/_static中创建一个样式表，只包含您想要的css，例如.wy-nav-content{max-width:none;}或.wy-nav-content{ma
我在我的Rails应用程序中使用Capybara和Cucumber。我想运行Sphinx重新索引和Redis服务器，以便为某些特定的测试场景运行。但这里的缺点是场景非常非常慢，需要运行数小时。这是我的env.rb文件require'rubygems'ENV["RAILS_ENV"]="cucumber"require'cucumber/rails'require'capybara/cucumber'require'capybara/rails'require'capybara/session'require'rake'Capybara.default_selector=:cssActi
好的，我下载了sphinx-0.9.9.tar.gz到我的桌面我解压缩到桌面上名为sphinx的文件夹。我跑:cd~/Desktop/sphinx./configure--prefix=/usr/local/sphinx--with-mysql很多事情都会发生。然后我运行这一行make我收到这个错误:make:***Notargetsspecifiedandnomakefilefound.Stop.我在ubuntu10.04我已经安装了apache2,php5,mysql,mysqladmin我不知道这个错误是什么意思。更新其实我跑完后发现:./configure--prefix=/u
