微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

生成 sphinx 文档,其中包含来自本地目录的多个版本的文档

如何解决生成 sphinx 文档,其中包含来自本地目录的多个版本的文档

我目前有一个使用 sphinx 记录的软件。我创建了一个网站并使用 sphin autodoc 显示了实际的文档部分。现在,我在本地 python 版本上安装了这个包,所以我可以简单地说

.. autoclass:: packagename.Classname
   :members:

显示类的内容

我们的目标是创建文档的多个版本,并能够在侧边栏下拉菜单中使用例如sphinx-multiversion,但是由于文档与实际源代码分开,我不能简单地使用 autoclass,因为该指令只查看为本地 python 版本安装的包。有没有一种好方法可以为每个版本生成文档,然后使用类似的指令从我的实际网站中引用它?

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。