I am building a framework that supports plugins. I'd like to be able to
automatically generate documentation for these plugins at the same time I
generate documentation for the framework itself.
My directory structure looks like this:
/project-root
/docs <-- Framework documentation
/plugins
/plugin1
/docs <-- Documentation for this single plugin
/plugin2
/docs <-- Documentation for this single plugin
/plugin3
/docs <-- Documentation for this single plugin
Is there a way that I can automatically include the documentation of each
of these individual plugins when I build the entire framework?
This portion of documentation provides details on how to utilize the
plugins.
.. toctree::
:maxdepth: 2
../plugins/plugin1/docs/readme
../plugins/plugin2/docs/readme
../plugins/plugin3/docs/readme
This isn't scale-able to a decent number of plugins. It's also error prone
(ie. I forget to add it, or a contributor forgets to add it). Is there a
way to say "build all of the documentation in all subdirectories of
"plugins" and properly link to them in the main project's docs?
Thank you.
--
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.
