python-sphinx - 使用 intersphinx 进行内部文档

标签 python-sphinx

我想将 intersphinx 用于内部文档,以在各种内部服务和内部文档之间进行交叉链接。

但是,它们不在安全的内部网络上。

有没有办法将 intersphinx 指向 objects.inv那是在身份验证之后?

支持哪些身份验证方案?

最佳答案

不知道有没有办法拉objects.inv通过身份验证,但另一种解决方案是下载 objects.inv您需要的文件位于无需身份验证即可访问的位置,然后在 intersphinx_mapping 中指定该文件的本地副本conf.py 中的参数:

intersphinx_mapping = {'keyname', ('uri/to/doc/repo/root', 'uri/to/local/objects.inv')}

虽然您必须定期重新拉取文件以确保它是最新的,但就目前而言,也许总比没有好?

关于python-sphinx - 使用 intersphinx 进行内部文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/32416441/

相关文章:

python - 从 sphinx autodoc 发出 reStructuredText?

python - 类中的文档字符串或 __init__ 构造函数?

python - sphinx 可以忽略 python 文档字符串中的某些标签吗?

python-sphinx - Sphinx 无法导入模块依赖项

python-sphinx - 单独的sphinx构建目录和源目录用于版本控制

build - 指定 sphinx 输出的构建目录路径?

python - toctree嵌套下拉

python-sphinx - 合并来自多个项目的Sphinx文档

python - 如何让 Sphinx 以标准 Python 文档的方式在文本中标记 C 调用?

python - 如何让 Sphinx 自动摘要显示实例属性的文档?