我是狮身人面像的新手.我尝试了教程,但我没有在内容中生成链接.我得到的错误
C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'intro' that doesn't have a title: no link will be generated
C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe
rence to document 'zuhdi' that doesn't have a title: no link will be generated
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.
Build finished. The HTML pages are in build/html.
我创建zuhdi.rst并intro.rst在同一目录中index.rst.如何将标题放在文件中？
为了您的信息,我的index.rst包含以下行: …
我想将我的项目包含README.md在我的Sphinx文档中,例如
Can sphinx链接到不在根文档下面的目录中的文档？
- 在生成的Sphinx html文档中,我点击欢迎页面上的目录中的链接,然后转到README.md.
为此,readme_link.rst创建了包含行的文档
Readme File
-----------
.. include:: ../../README.md
我添加了这一行
README <readme_link>
进入toctree index.rst.与此同时,我README.md不会被解析为Markdown,而只是按原样打印到页面上.
我认为另一个想法可能是改为使用markdown文件readme_link.md,但是没有办法包含markdown文件.
如何将我的README.md解析为markdown？
(当然我不想把它重写为.rst.)
我试图从.rst文件中的markdown文件中跟随Render输出,但这不起作用.我README.md有一些标题
# First heading
some text
## Second heading 1
some text
## Second heading 2
some text
我得到了错误WARNING: ../README.md:48: (SEVERE/4) Title level inconsistent:.我理解"标题级别不一致"是什么意思？我需要使用其他符号 - 但读入它们我意识到答案是指rst符号.这意味着我的降价自述文件实际上并未转化为rst.
PS:尝试类似这样的人的其他人是 https://muffinresearch.co.uk/selectively-including-parts-readme-rst-in-your-docs/
我需要为每个模块创建一个sphinx项目,
每个模块共享一些常见的rsts,如公司信息,许可证等.
我的项目树是这样的:
./conf.py
./index.rst
./intro.rst
./about.rst
./device1/conf.py
./device1/index.rst
我在./device1/index.rst中写这个,但它不起作用,我怎么能导入父rst文件？
.. toctree::
:maxdepth: 1
../intro
../about
我正在使用Sphinx记录Python 3项目.Sphinx文档在doc,我想README.md在我的索引中包含我的顶级内容.假设我可以使用问题#825中的指令让Sphinx解析并渲染Markdown .
如果我doc/index.rst看起来像这样:
Index
=====
Modules
-------
.. toctree::
:maxdepth: 2
.. include:: ../README.md
... markdown被解析为reStructuredText(因为这是include指令的工作原理).这意味着大多数降价格式被忽略.
即使链接也不起作用:无法直接创建上述文档的链接doc/,任何解决方法仍然需要在reST中包含降价文档.无论如何,我真正想要的是索引中呈现的内容.
有可能以某种方式告诉Sphinx文档的一部分使用与其他部分不同的标记语言,还是更改文档部分的解析上下文？或者是否有其他方法告诉它在解析完成后将一个文档注入另一个文档？
我是 Sphinx 的新手，想在两个不同的*.rst文件中显示相同的图形。
第一个 *.rst 文件"lower.rst"与“figures”文件夹位于同一级别，我在其中包含一个图形，如下所示：
.. figure:: figures/figure1.png
第二个 *.rst 文件"higher.rst“，比lower.rst 高几个级别。实际上，我将lower.rst 包含在higher.rst 中，如下所示：
.. include:: relative/path/to/lower.rst.
不幸的是，在 中higher.rst，lower.rst 中的数字没有显示：
"image file not readable" error.
higher.rst 在当前目录中查找图形，而不是指向原始的下层目录。
这个问题有点在这里解决：Sphinx 可以链接到不在根文档下面的目录中的文档吗？，但我仍然不明白如何使用那里提供的信息解决我的问题。