我正在使用Sphinx来记录非Python项目.我想./doc在每个子模块中分发文件夹,其中包含submodule_name.rst用于记录该模块的文件.然后我想将这些文件吸入主层次结构中,为整个设计创建一个规范.
即:
Project
docs
spec
project_spec.rst
conf.py
modules
module1
docs
module1.rst
src
module2
docs
module2.rst
src
我试图将文件包含在主project_spec.rst文档toctree中,如下所示:
.. toctree::
:numbered:
:maxdepth: 2
Module 1 <../../modules/module1/docs/module1>
但是,此错误消息导致:
警告:toctree包含对不存在的文档u'modules/module1/docs/module1'的引用
是不是可以以../某种方式在文档路径中使用？
更新:添加conf.py位置
在我的文档版本中,我一直收到警告"标题级别不一致".据我所知,我有一个一致的结构,看起来像:
Big Title
=========
Section
-------
Subsection
~~~~~~~~~~
但该错误与automodapi我无法追踪的autogenerated()文本相关联:
Classes
^^^^^^^
我怎样才能找出"不一致"的来源？
我Sphinx用于记录Python项目,并希望将现有.md文件的内容显示在.rst文件中.(我已经设置了conf.py允许降价).
例如,我有一个名为的文件tutorial.md.我还有一个.rst文件如下:
ml
==
w2v
^^^
.. automodule:: package.ml.w2v
:members:
我希望能够包含tutorial.md如下链接,以便tutorial.md在呈现时将在文件中显示内容.这可以通过以下方式实现:
ml
==
Tutorial
--------
.. include:: ../tutorial.md
w2v
^^^
.. automodule:: package.ml.w2v
:members:
但是,结果内容看起来很糟糕,因为它不会将降价呈现为降价.
我意识到我可以通过编写整个文档来避免这个问题.md,但是这个练习给我留下了以下问题:
是否有可能有.md内容呈现为降价,里面的的.rst文件吗？