如何使用Readthedocs/sphinx在monorepo中记录项目



我想使用readthedocs.org平台来记录一组使用monoreo原理存储的相关软件。存储库结构如下:

/
+- ComponentA
|  |- docs
|  |- component-a-source
|
|- ComponentB
|  |- docs
|  |- component-a-source
|
|- ComponentC
|  |- docs
|  |- component-a-source
|
|- Makefile

我在docs目录中为每个子组件准备了文档,现在我遇到了麻烦:如何习惯地设置readthedocs来托管我的每个组件?

我发现的一个解决方案是在web管理的"高级设置"部分手动导入三次存储库并将路径设置为conf.py;但是,我失去了使用.readthedocs.yaml文件配置的可能性。

我想到的另一个解决方案是在根目录中创建单独的docs目录,并以某种方式将三个文档合并到这个目录中。但它涉及到组件文档之间的大量重复;合并的";文档我对狮身人面像只有一点点经验。

在readthedocs.org中记录monorepo的惯用方法是什么?

Read the Docs创建了一个Sphinx扩展来管理这个特定的用例。查看其文档https://sphinx-multiproject.readthedocs.io/

相关内容

  • 没有找到相关文章

最新更新