如何将外部文件和从索引添加到狮身人面像目录的部分?

问题描述 投票:0回答:1

[我正在用sphinx构建我的python软件包文档,但是我很难将docs文件夹中其他文件的所有条目以及index.rst上其他节的条目都添加到目录中。

这些是我的docs文件夹内容:

$ ls docs/
api_reference.rst  _build  conf.py  index.rst  make.bat  Makefile  _static  _templates

这些是index.rst的第一行:

Welcome to SPIN's documentation!
================================

This is the Sorting Points Into Neighborhoods clustering method documentation.

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

   :ref:`Introduction`
   api_reference

.. _introduction: 

Introduction
============

Sorting Points Into Neighborhoods, aka SPIN, is clustering
technique that only relies on the data and does not map any function on the
original space of the data points. :ref:`Introduction`

对简介部分的第二个参考有效,但在toctree上的第一个参考无效。

我如何在目录中同时添加api引用和简介?

python python-sphinx tableofcontents
1个回答
0
投票
© www.soinside.com 2019 - 2024. All rights reserved.