Python 不能';t使用recomonmark将README.md的相对路径添加到Sphinx
因为M2R在狮身人面像X3中被弃用。我试图使用RecomonMark,以便将README.md包含到我的文档中 我有以下结构Python 不能';t使用recomonmark将README.md的相对路径添加到Sphinx,python,python-sphinx,Python,Python Sphinx,因为M2R在狮身人面像X3中被弃用。我试图使用RecomonMark,以便将README.md包含到我的文档中 我有以下结构 project |--README.md |--docs |--|--conf.py |--|--index.rst |--|--... 在conf.py中,我向扩展添加了recomonmark。并且在source\u后缀中有“.md” 在索引.rst中 我有 .. toctree:: :maxdepth: 2 ../README.md modul
project
|--README.md
|--docs
|--|--conf.py
|--|--index.rst
|--|--...
在conf.py
中,我向扩展添加了recomonmark
。并且在source\u后缀中有“.md”
在索引.rst中
我有
.. toctree::
:maxdepth: 2
../README.md
modules
但是斯芬克斯找不到它:
WARNING: toctree contains reference to nonexisting document 'README'
我可以通过创建一个到docs文件夹的README软链接来解决这个问题。但这对于版本控制来说似乎不太合适。我担心构建会在其他机器上中断,或者在将来的配置更改中中断
那么有没有办法将README.md从项目目录包含到index.rst
非常感谢您可以使用间接寻址 index.rst 自述文件
金字塔文档可以。您可以使用间接寻址 index.rst 自述文件
金字塔文档可以。不幸的是,这也不起作用。它没有标题。我加了一个标题。README.md直接作为rst加载,这会弄乱所有格式。在金字塔中没有问题,因为所有文件都是rst。。。在使用m2r之前,我可以使用mdinclude::而不是include:,但现在它不再受支持。间接寻址可以工作,否则您将不会收到关于README.md语法的新错误。请使用README.md的来源编辑您的问题,以便我能进一步提供帮助。另一个选择是运行一个脚本,在构建文档并将其放入文档目录时将README.md转换为有效的reST。到目前为止有解决方案吗?不幸的是,这也不起作用。它没有标题。我加了一个标题。README.md直接作为rst加载,这会弄乱所有格式。在金字塔中没有问题,因为所有文件都是rst。。。在使用m2r之前,我可以使用mdinclude::而不是include:,但现在它不再受支持。间接寻址可以工作,否则您将不会收到关于README.md语法的新错误。请使用README.md的来源编辑您的问题,以便我能进一步提供帮助。另一个选择是运行一个脚本,在构建文档并将其放入文档目录时将README.md转换为有效的reST。到目前为止有什么解决方案吗?请注意,RecomonMark不赞成使用myst解析器请注意,RecomonMark不赞成使用myst解析器
.. toctree::
readme
.. include:: ../README.md