collect all directives

[Brett Dixon]

I wasn't sure ho to phrase this or even what to search for.  I would like to be able to add a custom directive to my docstrings, then have another extension keep track of all of these and add them to an index page.

The use case is tool documentation.  I will document the tool ui in the module and add images, etc.  However these are all over and could be deep within my project so discovering the page would be bad for users.  I'd like to have something curate these for me instead of having to link them in a maintained doc.

an example

path/to/foo.py

...

"""

  .. tooldoc::

  

    This is my tool and it does things

    .. image:: /path/to/image1.png

...

other/path/to/bar.py

...

"""

.. tooldoc:: 

    This is my other tool and it does nothing

    .. image:: /path/to/image2.png

...

index.rst

.. autotooldoc::

Utlimately index.html would render out links to foo.py and bar.py

Hope that makes sense.  Is there an extension that does something similar I can look at?

Thanks

[Brett Dixon]

should have read the tutorial a bit more, the todolist does this :/