sphinx能否链接到位于.rst文档上方一个路径中的文档?

2024-05-13 20:54:15 发布

您现在位置:Python中文网/ 问答频道 /正文

我正在尝试使用Sphinx的基础知识来记录一个小项目。但我无法让他找到上面目录中的文件

项目结构如下:

/Users/machine/workspace/project1

├── BDRespostas.py
├── constantes.py
├── docs
│   ├── conf.py
│   ├── index.rst
│   └── make.bat
├── estatisticas.py
├── migrate_postgre_sqlite.py
├── preProcessamentoTextual.py
└──

我尝试了几种方法来配置index.rst,但没有成功:

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   :ref:'estatisticas.py'
   ../BDRespostas.py
   '/Users/machine/workspace/project1/constantes.py'

我还多次尝试将sys.path.insert()添加到项目目录。如果你已经设法做了这个介绍,并能帮助我,我真的很感激


Tags: 项目py目录indexsphinx记录rstmachine
1条回答
网友
1楼 · 发布于 2024-05-13 20:54:15

如上所述,toctree用于包含文档(.rst文件),而不是Python源代码。告诉我们你想要实现什么

不要掩饰它-目录树只能包含来自当前文件夹或子文件夹的文档。也就是说,你不能

.. toctree::
   
   ../one.rst
   ../two/three.rst

相关问题 更多 >