可以在conf.py中指定Sphinx构建的主文档的路径。但是，此目录路径反映在生成的HTML中，例如，在“将文档作为缺少的索引读取”中显示。所以这是我之前得到的： conf.py things doc2.rst conf.py index.rst
th
浏览 19提问于2020-02-28得票数 1
所以我把python源文件放在两个不同的目录中：-~/work/myproject如何使用sphinx-apidoc递归地查看两个目录以生成显然，非常好，但是当我试图跑
sphinx-apidoc -o docs/source ~/.virtualenvs
浏览 6提问于2012-10-29得票数 11
使用sphinx，我如何让我的git仓库根目录中的README.rst包含在我的sphinx文档中的index.rst中？我正在使用apidoc和autodoc。一个很好的例子是APScheduler，如果你看一下，你会注意到他们的docs/index.rst和他们的README.rst几乎一样
浏览 1提问于2015-01-28得票数 2
我有一个包含python包的目录，如下所示：--docs/...--app/__init__.py我用sphinx和autodocs来记录这个应用程序(在python3.3中)。现在，在conf.py (inside docs/)中，我已经我cd进入docs/，运行这给
浏览 2提问于2013-11-27得票数 11
回答已采纳
我被蟒蛇sphinx困住了。我的目录树如下所示：| | - importable_project| |下面是index.rst文件当前的样子：
..我知道这里指定的文件路径相对于index.rst文件的位置。因此，在本例中，project_root/docs/source和sphinx能够使用上面的index.rst文件为moudles.rst生成h
浏览 2提问于2017-10-11得票数 0
回答已采纳
我正在编写一个Django应用程序来提供一些用RestructuredText编写的文档。我有很多用*.rst写的文档，每个文档都很长，有很多章节，小节等等。谁能告诉我构建*.rst文档的文档树并解析其中的单个部分的方向，或者建议一种聪明的方法来获得类似的结果？
浏览 1提问于2010-08-24得票数 2
回答已采纳
1回答
我正在运行sphinx-quickstart，但不理解第一个问题：这是什么意思？这些目录是否分开又有什么区别呢？我怎么知道该选哪一个？
浏览 1提问于2021-01-21得票数 5
回答已采纳
我正在尝试使用Sphinx创建一个ReadTheDocs文档。为了在我的本地机器上测试它，我使用了Sphinx的docker镜像sphinxdoc/sphinx。&& sphinx-apidoc -F -o /repo/docs/_source /repo && make html'
这样做的问题是它会生成错误的包，因为sphinx-apidoc使用子文件夹来生成包extensions =
浏览 8提问于2021-02-05得票数 1
| | |───modA.rst| ├───index.rst正如Sphinx文档中提到的，我插入了工作目录的and路径，将sphinx.ext.autodoc添加到扩展列表中，并将autosummary_generate设置为conf.py中的True。= [ "sphinx.
浏览 6提问于2020-06-06得票数 6
我告诉Sphinx在sphinx-quickstart期间使用单独的源代码和构建目录。现在我的目录布局如下： myproject/ mymodule.py source/ .templates/ index.
浏览 0提问于2012-03-06得票数 32
回答已采纳
Separate source and build directories (y/n) [n]: yroot source index.rst("."))[REST OF FILE UNCHANGED] build
浏览 6提问于2022-08-18得票数 -1
sphinx支持选项-隐式名称空间来根据PEP420处理命名空间包。当我用"python setup.py build_sphinx“创建狮身人面像文档时，默认情况下，这并不适用于命名空间包。"python setup.py build_sphinx“和sphinx之间是否有关系(例如，在运行"python setup.py build_sphinx”时，sphinx是否在某个地方隐式调用？)如果是这样的话，我是否可以专门说明"python set
浏览 6提问于2017-06-26得票数 0
我有一个flask应用程序，我想使用Sphinx的autoflask指令来记录flask-restful API。我已经通过pip安装了该模块，并运行了sphinx-quickstart，这将为我提供一个conf.py和index.rst。因此，当我运行sphinx-build时，我得到一个错误，即找不到应用程序或模块。.├── apis│ ├── static在应用程序的根目录中，我可以说：
from apis impor
浏览 0提问于2016-01-26得票数 7
1回答
我还有一个子目录apidoc，其中包含一个文件agent.rst (由sphinx-apidoc生成)：============
:undoc-members:我使用sphinx-build -b html apidoc apidoc/_build运行狮身人面像，项目的目录是当前的工作目录。Update：最初的问题可能是由于我没有在conf.py中包括<
浏览 4提问于2020-01-24得票数 6
回答已采纳
2回答
我能告诉sphinx-build不要再找index.rst了吗？$ sphinx-build -C . ./index.rst not found$ ln -s readme.rst index.rst这实际上将同时构建index.rst和readme.rst
浏览 2提问于2020-04-22得票数 0
回答已采纳
我在使用sphinx-build创建文档目录(html)时遇到麻烦。我试过了以及但在这两种情况下，只生成html文件search.html、index.html和genindex.html我在Windows上使用Sphinx1.1.3和Python2.7。
浏览 8提问于2012-12-12得票数 45
文件/home/user/myproject/docs/source/index.rst如下： :glob:
我收到以下有关在/home/user/myproject/docs/source/design/index.rst:: WARNING: document isn't included in any toctree
我做错了什
浏览 0提问于2012-03-02得票数 3
回答已采纳
尝试使用Sphinx生成文档。 首先使用：sphinx-apidoc，然后使用：sphinx-build html 我收到了关于modules.rst文件的警告。文件存在，同时也生成了html，它看起来绝对像是一个目录。我阅读了我能找到的关于这个主题的所有主题，都没有解决这个问题(使用.. include::指令，在index.rst文件中正确定位模块的位置...)\doc\sphinx\index.rst:4: WARNING: toctree contains re
浏览 333提问于2020-07-10得票数 2
回答已采纳
我手写的文档/用户指南(用ReStructuredText和sphinx编写)变得非常大，所以我开始在子目录中组织我的.rst文件。在index.rst中，我包含了每个子目录的subindex.rst，它本身的文件系统还包含了其他子目录的.rst-files。index.rst.. include:: subdir2/subindex.rst
subdir1/subindex.r
浏览 5提问于2017-06-15得票数 19
回答已采纳
云服务器
ICP备案
实时音视频
即时通信 IM
云直播
腾讯云开发者
