Python sphinx 是否可以在我的文档中包含外部rst文件?
我正在为包含模块的平台构建文档。我想让文档存在于这些模块存储库中,并使用include命令将它们包含在“master”文档中 我尝试了以下方法:Python sphinx 是否可以在我的文档中包含外部rst文件?,python-sphinx,read-the-docs,Python Sphinx,Read The Docs,我正在为包含模块的平台构建文档。我想让文档存在于这些模块存储库中,并使用include命令将它们包含在“master”文档中 我尝试了以下方法: .. include:: https://github.com/12rambau/sepal_ui_template/blob/master/doc/en.rst 但文件中没有添加任何内容 是否可以在包含命令中使用绝对链接?否。完全限定的URL与文档无关。根据以下文件: 指令参数是要包含的文件相对于包含该指令的文档的路径 还有其他选择,包括。我的主要
.. include:: https://github.com/12rambau/sepal_ui_template/blob/master/doc/en.rst
但文件中没有添加任何内容
是否可以在
包含命令中使用绝对链接?否。完全限定的URL与文档无关。根据以下文件:
指令参数是要包含的文件相对于包含该指令的文档的路径
还有其他选择,包括。我的主要目标不是使用include
命令,而是避免代码复制并使用web上可用的文件。根据答案,我提出了以下解决方案:
在conf.py文件中,我从github复制了文件的内容
小心使用raw.githubusercontent.com
链接避免导入html
# [...]
#--复制模块文档------------------------------------------
从urllib.request导入urlretrieve
URL检索(
"https://raw.githubusercontent.com/12rambau/sepal_ui_template/master/doc/en.rst",
“模块/sepal\u ui\u模板.rst”
)
之后,在我的文档中的modules/sepal\u ui\u template.rst
下创建文件,我可以安全地访问它
每次我重建文档时都会再次下载它。因为它可能是安全黑洞,我怀疑该指令是否接受这样的URL。