I don't think this is possible with sphinx, AFAIK. You could always write a script to find all .py files in a certain directory, and output the corresponding "automodule" .rst files in your docs/source directory. You lose a lot of control/flexibility this way, but it's worth it if it's a large project and you're sure you never want to do anything other than automodule.
> On Jun 19, 2018, at 1:24 PM, Manos Seferidis <[email protected]> > wrote: > > Hi guys, took me quite some time to get my first extension working and it > works fine. > > I can do something like below for documenting a data engineering project > > > .. coldefs:: > > netdist: Distribution of data in the network. > > The main issue I am having is that I can't figure out how to make Sphinx read > all the docstrings globally from the project. The directive coldefs can be > used anywhere int he codebase and I simply want > to be able and aggregate that information into a single page. Is that even > possible? > > So far I need to include every single module where the docstrings appear like > .. automodule:: myproject.yadayada.yadaagain then I need to use my custom > directive .. coldefs_listing:: and it works. The problem > is that it doesn't pick up any docstrings outside the automodule directive. > > > > DISCLAIMER: The content of this email and its attachments, if any: (i) may be > confidential and/or legally privileged and must not be disclosed by > unintended recipients who should delete anything received in error and kindly > notify us; (ii) may not be virus or error free and recipients should first > satisfy themselves that they are safe to open as we accept no liability for > any loss, damage or other consequences caused by receipt or opening of them > whether in tort or otherwise. OpenSignal Limited is a company listed on the > Registrar of Companies of England and Wales. A list of Directors is available > for inspection at the registered office. > > > > > -- > 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] > <mailto:[email protected]>. > To post to this group, send email to [email protected] > <mailto:[email protected]>. > Visit this group at https://groups.google.com/group/sphinx-users > <https://groups.google.com/group/sphinx-users>. > For more options, visit https://groups.google.com/d/optout > <https://groups.google.com/d/optout>. -- 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.
