simpeg / aurora

software for processing natural source electromagnetic data
MIT License
13 stars 2 forks source link

Documentation recursion level not deep enough to see all modules #336

Open kkappler opened 1 month ago

kkappler commented 1 month ago

As I was adding a few docstrings here and there, I thought to take a look at my latest docs/_build to see how the they look in HTML.

Doing that I noticed that there are actually several directories in the aurora package that do not seem to be indexed by the documentation. Specifically, under aurora/aurora/transfer_function, the *.py files are in the docs, but none of the sub-folders, such as regression are clickable.

I tried editing max_depth from 2 to 3 in docs/api/index.rst

.. toctree::
    :maxdepth: 3
    :caption: API documentation

and editting max_depth from 2 to 3 (and even 4) in docs/index.rst for reference documenation

.. toctree::
   :maxdepth: 4
   :caption: Reference documentation

Alas, after calling make html had no change in the resultant webpage that I could see.

kkappler commented 1 month ago

The issue also seems to be on the simpeg hosted website.

Tried modifying docs/api/index.rst, both by increasing max_depth from 2 to 3 (or even 33), and did not get deeper doc into subfolders of transfer_function. Also tried adding the line :recursive under toctree, but that did not solve the issue.

It looks like this post got it figured out ..

Specifically, here is an example where they show recursion into submomdules: