相关疑难解决方法(0)

结合多个子项目的Sphinx文档:处理索引,同步配置等

我们有一个用(优秀的)Sphinx记录的多模块项目.我们的设置与邮件列表中描述的设置没有什么不同.总的来说这很棒!但是我们有一些关于这样做的问题:

  1. 子模块目录将包括索引链接.充其量这些将链接到错误的指数.(在最坏的情况下,这似乎会引发Sphinx中的错误,但我正在使用devel版本,这是合理的).有没有办法只为最顶层的toctree生成索引链接?

  2. 是否有保持Sphinx配置在多个项目之间同步的最佳实践?我可以想象在一起乱砍某些东西from common_config import *,但对其他方法感到好奇.

  3. 虽然我们在这里,但邮件列表中提出的问题(替代symlinking子项目文档?)从未得到回答.这对我来说并不重要,但对其他读者来说可能很重要.

python documentation python-sphinx

23
推荐指数
1
解决办法
6517
查看次数

如何使用sphinx获得多个版本的doc?

像python或django的文档一样,我如何使用sphinx获得多个版本的doc?

我保存在我的git的文档,我希望我的用户能够看到文档不同版本的一样v2.7,v3.4

感谢您的帮助

python-sphinx

16
推荐指数
2
解决办法
3970
查看次数

sphinx用于多个单独的文档

我对Sphinx很新,在服务器上记录我的项目.现在,一位同事看到了我一直在做的事情,她想做同样的事情 - 在同一台服务器上记录她的项目.

项目没有关系(他们不属于一个TOCtree),我不知道如何帮助她.我可以配置sphinx来构建单独的文档树吗?是否像制作Makefile的两个副本一样简单并让它设置不同的源/构建目录?

谢谢, - 蒂姆

python-sphinx

4
推荐指数
1
解决办法
2039
查看次数

标签 统计

python-sphinx ×3

documentation ×1

python ×1