☰

Sphinx：.rstでTOCを生成する

tag-icon • tag-icon restructuredtext
Sphinx：.rstでTOCを生成する

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 で生成されました。

答え1

最適ではないソリューションを達成する方法を見つけました。それぞれにtoctreeセクションを作成します。

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

   parallel

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

   sem

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

   env_parallel

これにより、各ファイルにタイトルが付与されます。

関連情報