Sphinx - добавление индекса в индекс в toctree для включения блокнотов с nbsphinx - PullRequest
Новая
       15

Sphinx - добавление индекса в индекс в toctree для включения блокнотов с nbsphinx

0 голосов
/ 20 января 2019

Я пишу документацию и следую эту структуру. 

.. toctree::
   :maxdepth: 5
   :caption: Contents:

   installation.rst
   quickstart.rst
   data.rst
   geometry.rst
   compute.rst
   math.rst
   process.rst
   plotting.rst
   references.rst

Я использую nbsphinx, чтобы включить некоторые примеры в форму ноутбука jupyter. У меня много разных тетрадей, которые я не хочу отображать в качестве заголовков в моем дереве. Я могу это сделать. 

   .. toctree::
   :maxdepth: 5
   :caption: Contents:

   installation.rst
   quickstart.rst
   data.rst
   geometry.rst
   compute.rst
   math.rst
   process.rst
   plotting.rst
   notebook1.ipynb
   notebook2.ipynb
   references.rst

Однако мне бы хотелось, чтобы это было так: 

      .. toctree::
   :maxdepth: 5
   :caption: Contents:

   installation.rst
   quickstart.rst
   data.rst
   geometry.rst
   compute.rst
   math.rst
   process.rst
   plotting.rst
   workflows -----> which i do not want a .rst file because i want which notebook be one header on my toc
   references.rst

будет выглядеть 

  Worflows
  =========

  notebook1
  ------------

  notebook2
  -----------
  .....

Я не хочу, чтобы они показывались непрерывно в одной и той же паге, они должны быть на каждой отдельной странице. Может быть, если я могу добавить index.rst, для рабочих процессов, внутри моего index.rst Я надеюсь, что я был ясен.

...