Sphinx: .rst별로 TOC 생성

2024-6-7 • tag-icon

GNU Parallel의 (지루한) POD-html을 Sphinx로 변환하려고 합니다.

나는 이것을 사용합니다 index.rst:

.. SPDX-FileCopyrightText: 2021 Ole Tange, http://ole.tange.dk and Free Software and Foundation, Inc.
..
.. SPDX-License-Identifier: GPL-3.0-or-later

.. GNU Parallel documentation master file, created by
   sphinx-quickstart on Sat Jan 23 14:06:27 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to GNU Parallel's documentation!
========================================

.. toctree::
   :maxdepth: 3
   :caption: Contents:

   parallel
   sem
   env_parallel
   parset
   parsort
   parallel_design
   parallel_tutorial
   parallel_alternatives
   parcat
   niceload
   sql


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

다음 파일이 생성됩니다.https://www.gnu.org/software/parallel/parset.html

여기서 문제는 왼쪽 사이드바에 다른 모든 파일이 아닌 관련 제목만 포함하기를 원한다는 것입니다 parset(예: 목차 아래의 상단 링크는 Parallel.html에 연결됨). 또는 최소한 다음을 수행해야 합니다. 각 새 파일에 사용자가 제목을 삽입하도록 하십시오. 다른 명령에 대한 링크를 볼 수 있습니다.

index.rst현재 파일의 내용에만 기반을 두도록 하려면 몇 가지 마법을 추가하면 된다고 가정합니다 .

(.rst 파일은 pod2rst를 사용하여 POD에서 생성되었습니다. 예, 일부 형식 오류가 있지만 문서를 .rst 형식으로 유지하지 않습니다.)

답변1

최적이 아닌 솔루션을 달성하는 방법을 찾았습니다. 각각에 대해 toctree 섹션을 만듭니다.

.. toctree::
   :maxdepth: 1
   :caption: parallel

   parallel

.. toctree::
   :maxdepth: 3
   :caption: sem

   sem

.. toctree::
   :maxdepth: 3
   :caption: env_parallel

   env_parallel

이렇게 하면 각 파일에 제목이 부여됩니다.

답변1

관련 정보