[bugfix docs] Fix shadow module TOC

[Qottmann]

Came up in a separate PR, fixing a bug in the docs of the TOC in the shadows module

I compared it with the fermi module description and made the structure

• overview
  • measurements
  • etc
• descriptions etc.

see module page in preview vs. current version

before:

after:

Also added some cosmetic changes like putting a one-line description in the overview

[github-actions]

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

• A one-to-two sentence description of the change. You may include a small working example for new features.
• A link back to this PR.
• Your name (or GitHub username) in the contributors section.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.59%. Comparing base (9068353) to head (6370676).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6955   +/-   ##
=======================================
  Coverage   99.59%   99.59%           
=======================================
  Files         480      480           
  Lines       45651    45651           
=======================================
  Hits        45466    45466           
  Misses        185      185           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[josh146]

Thanks @Qottmann! I don't quite understand why splitting it up between two different files affects the title hierarchy :(

I guess ideally the documentation lives in the __init__.py file, since then it is closer to the code/developers who change the code remember to update it

[dwierichs]

👍

[Qottmann]

Thanks @Qottmann! I don't quite understand why splitting it up between two different files affects the title hierarchy :(

I guess ideally the documentation lives in the init.py file, since then it is closer to the code/developers who change the code remember to update it

Good point! I think the problem was actually that the overview headline was in the rst file. I moved now everything to the init, including the overview headline, and it seems fine. I also prefer to have it closer to the code! Now the fix is also easier

looks good to me