Как включить страницы, созданные во время сборки?

#python-sphinx #restructuredtext

#python-sphinx #реструктурированный текст

Вопрос:

Я стремлюсь создать страницу «Ссылки на API», раскрывающую genindex.html и py-modindex.html ; проблема в том, что я предпочитаю, чтобы вся страница была не просто интерактивными ссылками на указанные страницы, а фактически включала их содержимое. Мы можем сделать это с помощью README — однако, README.rst существует в source/ , тогда как genindex.html есть только в build/ , поэтому ниже не работает:

 .. include:: modindex
.. include:: genindex
.. include:: modindex.rst
.. include:: genindex.rst
.. include:: ../build/genindex.html
  

Можно ли это выполнить?

Комментарии:

1. Не из коробки. genindex.html это специальная страница, созданная Sphinx. Вам нужно будет погрузиться в его внутреннюю работу и написать некоторый код на Python, чтобы это произошло. Смотрите sphinx-doc.org/en/master/_modules/sphinx/builders/html.html и sphinx-doc.org/en/master/usage/restructuredtext /…

2. @StevePiercy Спасибо; думаю, я просто установлю страницу на одну из них вместо включения обеих.

3. Похоже, это тоже невозможно (toctree)

4. Правильно, потому что они не являются исходными файлами. Sphinx автоматически создает специальные страницы. Однако вы могли бы использовать :ref:'genindex' замену ' обратными ссылками.