Inclua o ToC de outra página no Sphinx

10

Eu tenho a seguinte página em plugins / index.html:

Plugin Development
==================

.. toctree::
   :hidden:

   basics/index
   advanced/index


The Basics
----------

- :doc:'basics/gettingstarted'
- :doc:'basics/resources'
- :doc:'basics/i18n'


Advanced Topics
---------------

- :doc:'advanced/models'
- :doc:'advanced/controllers'
- :doc:'advanced/services'

plugin / basics / index.html e plugins / advanced / index.html contêm seus próprios toctree's, que são vinculados às mesmas subpáginas listadas em plugins / index.html. Então, o que eu estou querendo saber é, existe uma maneira de incluir apenas as subcontratações, em vez de listar manualmente as subpáginas como estou fazendo?

Eu percebo que eu poderia simplesmente remover o sinalizador: hidden: da toctree, mas o ponto é que eu quero manter os tópicos Básico / Avançado em listas separadas, com seus próprios cabeçalhos, intro parágrafos, etc.

    
por Brandon Kelly 26.10.2012 в 23:24
fonte

1 resposta

5

Você pode listar todo o conteúdo do diretório como este (ou várias combinações dessas diretivas):

.. toctree::
  :glob:
  :titlesonly:
  :maxdepth: 2

  **

ou eu também penso assim (não testado):

.. toctree::
  :glob:
  :titlesonly:
  :maxdepth: 2

  *
  basics/*
  advanced/*

No entanto, descobri que apenas listar manualmente as coisas geralmente é o melhor caminho a seguir. Embora os TOCs gerados automaticamente sejam bons, eles não permitem muito espaço em termos de formatação (por exemplo, criação de subtítulos e alteração da ordem das páginas, etc.).

Na nossa documentação, fiz praticamente a mesma coisa que você fez na pergunta inicial.

    
por Adrian Macneil 02.11.2012 / 02:44
fonte