radical-cybertools / radical.utils

Utility classes and tools for various radical projects
Other
8 stars 6 forks source link

Clean up the RST doctree. #376

Closed eirrgang closed 1 year ago

eirrgang commented 1 year ago

This change addresses several issues:

To deduplicate documentation, the doctree is simply flattened a bit, though section delimiters are adjusted to better represent the document hierarchy.

Since there is no docstring for most packages (__index__.py files), the automodule directive didn't do anything, and is replaced with a static module directive in the rst document.

Ref #375

codecov[bot] commented 1 year ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 61.46%. Comparing base (d624ce1) to head (747e953). Report is 312 commits behind head on devel.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## devel #376 +/- ## ======================================= Coverage 61.46% 61.46% ======================================= Files 60 60 Lines 6721 6721 ======================================= Hits 4131 4131 Misses 2590 2590 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.