Docs: Fix Headings in Docs [Closes #2472] #2474
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2474 +/- ##
=======================================
Coverage 92.46% 92.46%
=======================================
Files 234 234
Lines 19868 19868
=======================================
Hits 18370 18370
Misses 1498 1498 ☔ View full report in Codecov by Sentry. |
aknierim
changed the title
Tobychev
added
the
documentation-only
docs/api-reference/tools/index.rst
Outdated
| Command line tools (`~ctapipe.tools`) | ||
| ===================================== | ||
| ************************************* | ||
| Command-Line Tools (`~ctapipe.tools`) |
There was a problem hiding this comment.
In docs/api-reference/reco/index.rst (and in other places) you capitalise hyphenated words ("Moment-based") as "Capital-lowercase" but here you write "Command-Line", that is using a "Capital-Capital" format. I think you chose what format to use and use that consistently.
There was a problem hiding this comment.
Oh, you're right. I decided to stick with "Capital-lowercase" when going through the files, but I guess I missed that one.
Change "To API docs" to "To the API docs", since that is more consistent with the other two cards, i.e. "To the user guide" and "To the developer guide".
|
That should fix it if I haven't overlooked any further inconsistencies. |
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 Referenceare changed toReference/APIand the capitalization of some headings is changed for consistency.