NRLMMD-GEOIPS / geoips

Main Geolocated Information Processing System code base with basic functionality enabled.
https://nrlmmd-geoips.github.io/geoips/
Other
13 stars 10 forks source link

Documentation better release notes #588

Open biosafetylvl5 opened 1 month ago

biosafetylvl5 commented 1 month ago

Testing Instructions

Build the docs.

Summary

I added top-level summaries to each version number. Eg. version X.0.0 -> X.1000.1 summarized under Version X. See changes for details 🙂

Output: Passes doc8

➜  geoips git:(documentation-better-release-notes) doc8 --max-line-length 120 ./docs/source/releases/index.rst 
Scanning...
Validating...
========
Total files scanned = 1
Total files ignored = 0
Total accumulated errors = 0
Detailed error counts:
    - doc8.checks.CheckCarriageReturn = 0
    - doc8.checks.CheckIndentationNoTab = 0
    - doc8.checks.CheckMaxLineLength = 0
    - doc8.checks.CheckNewlineEndOfFile = 0
    - doc8.checks.CheckTrailingWhitespace = 0
    - doc8.checks.CheckValidity = 0

Relevant XKCD

at least geoips isn't this bad