Pinken docs for doc8 🩷

[biosafetylvl5]

PS I am testing out a new repo template, please comment what you think of it:

The template:

**🔍 Existing Tests:**
- ✅ **Required:** I ran existing tests, and they all pass (e.g., `full_test.sh`)
  - Full test suite (`full_test.sh`) passes
  - Other tests (specify) pass
- ❌ **Not Required**

**🧪 Unit Tests:**
- ✅ **Required:** I added Unit tests for new/modified functionality and they *pass*
- ❌ **Not Required**

**🔗 Integration Tests:**
- ✅ **Required:** I added integration tests for new/modified functionality and they *pass*
- ❌ **Not Required**

**👼 Documentation:**
- ✅ **Required:** I added documentation for new/modified functionality
- ❌ **Not Required**

** 🕸️ Updates to Other Repositories:**
- ✅ **Required:** I made updates to these other repositories:
    -  
- ❌ **Not Required**

I removed the "explain reasoning" because in most PRs, it's not filled out.

The template in use:

🔍 Existing Tests:

• ❌ Not Required

🧪 Unit Tests:

• ❌ Not Required

🔗 Integration Tests:

• ❌ Not Required

👼 Documentation:

• ❌ Not Required - Already in coding-standards.rst

🕸️ Updates to Other Repositories:

• ❌ Not Required

👪 Related Issues

fixes #479

🧪 Testing Instructions

Run doc8 at root:

doc8 --max-line-length 120 ./docs/source 

📖 Summary

I edited the docs to comply with .rst standards as enforced by doc8.

I tried these "black like" helper programs:

• rstfmt
• docstrfmt
• and a few others

None worked well. I wrote pinkrst to help, hence the name of this PR. I am fully convinced no one reads all of the PR descriptions. Let me know if you did :)

💻 Output

➜  geoips git:(documentation-pinkening) doc8 --max-line-length 120 ./docs/source 
Scanning...
Validating...
========
Total files scanned = 107
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

🙏 👼👼👼👼 we can now ascend to linter heaven 👼👼👼👼 🙏

[biosafetylvl5]

All manual changes done.

[biosafetylvl5]

What do y'all think about this? It fixes the line wrapping, and also makes the lines shorter/easier to read.

modified::

    example/really/long/ohso/long/justthelongest-notshort-superlong/filepath/that-is-SO-long/CHANGELOG_TEMPLATE.rst

renamed::

    really/long/ohso/long/justthelongest-notshort-superlong/filepath/that-is-SO-long/CHANGELOG_TEMPLATE.rst ->
    shortpath/just-an-example/CHANGELOG_TEMPLATE.rst

    really/long/ohso/long/justthelongest-notshort-superlong/filepath/that-is-SO-long/CHANGELOG_TEMPLATE.rst ->
    really/long/ohso/long/justthelongest-notshort-superlong/diffpath/that-is-SO-long/CHANGELOG_TEMPLATE.rst

deleted::

    really/long/ohso/long/justthelongest-notshort-superlong/filepath/that-is-SO-long/CHANGELOG_TEMPLATE.rst
    example/short/path.file

See https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#literal-blocks for rst conventions.

[jsolbrig]

I like that a lot. Let's see what @mindy thinks since she probably spends more time reading the changelogs than anyone else.

[biosafetylvl5]

Re: Adding pinkrst to geoips[doc], I think we can but it's not mature so it I think it would be better to wait until later.