search

cta-observatory / ctapipe

Low-level data processing pipeline software for CTAO or similar arrays of Imaging Atmospheric Cherenkov Telescopes
https://ctapipe.readthedocs.org
BSD 3-Clause "New" or "Revised" License
63 stars 266 forks source link

Docs: Fix Headings in Docs [Closes #2472] #2474

Closed aknierim closed 8 months ago

aknierim commented 8 months ago

This PR closes #2472 by fixing the headings in the docs. Headings are now set according to the convention mentioned in the Sphinx docs on reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections.

Additionally, occurrences of API Reference are changed to Reference/API and the capitalization of some headings is changed for consistency.

codecov[bot] commented 8 months ago

Codecov Report

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

Comparison is base (4a45dcd) 92.46% compared to head (d1bff23) 92.46%.

:exclamation: Current head d1bff23 differs from pull request most recent head fa945a6. Consider uploading reports for the commit fa945a6 to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2474 +/- ## ======================================= Coverage 92.46% 92.46% ======================================= Files 234 234 Lines 19868 19868 ======================================= Hits 18370 18370 Misses 1498 1498 ```

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

aknierim commented 8 months ago

That should fix it if I haven't overlooked any further inconsistencies.