, Я сам не пробовал, но уверен, что это сработает.
у использовать сфинксаавтоматическое расширение а такжешаблоны генерировать документы API рекурсивно из строк документации. Я хочу отдельные страницы для каждого модуля, класса, метода, свойства и функции. Но он не обнаруживает мои шаблоны вообще. На самом деле, если я просто удалюmodule.rst
файл из_templates/autosummary/
, он отображает весь файл точно так же, как и раньше. Я следовалэтот ТАК вопрос в письме. Если тебе интересно,полный репозиторий на GitHub.
Изменить: Кажется, он генерирует другой файл, мне пришлось удалить документы / _autosummary для него, чтобы прочитать новый шаблон. Однако теперь он генерирует файл сsparse
заголовок иdescription
заголовок. Это не входит в{% if classes %}
а также{% if functions %}
директивы.
Моя структура каталогов выглядит следующим образом:
редкийдокументыconf.pyindex.rstmodules.rst_templates / автореферат / module.rstВот соответствующие файлы на данный момент:
index.rst
:
.. sparse documentation master file, created by
sphinx-quickstart on Fri Dec 29 20:58:03 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to sparse's documentation!
==================================
.. toctree::
:maxdepth: 2
:caption: Contents:
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
modules.rst
:
API Reference
=============
Modules
-------
.. autosummary::
:toctree: _autosummary
sparse
_templates/autosummary/module.rst
:
{{ fullname | escape | underline }}
Description
-----------
.. automodule:: {{ fullname | escape }}
{% if classes %}
Classes
-------
.. autosummary:
:toctree: _autosummary
{% for class in classes %}
{{ class }}
{% endfor %}
{% endif %}
{% if functions %}
Functions
---------
.. autosummary:
:toctree: _autosummary
{% for function in functions %}
{{ function }}
{% endfor %}
{% endif %}