Hello, everyone. I have two issues:
First, autosummary does not seem to be finding my templates. When I delete
or modify the modules file, the generated docs don't change at all. I want
to use templates similar to module.rst below to generate API docs without
listing everything out. I want to generate autosummaries that link to
individual pages automatically. I have followed this SO answer
<https://stackoverflow.com/a/21665947/774273> to the letter. My directory
structure looks like the following:
- module1
- Module code here
- docs
- conf.py
- index.rst
- modules.rst
- _templates
- autosummary
- module.rst
Docs/index.rst looks like this:
.. 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`
docs/modules.rst:
API Reference
=============
Modules
-------
.. autosummary::
:toctree: _autosummary
module1
docs/_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 %}
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
