Add doc8 as a pre-commit hook

[leander-dsouza]

Basic Info

Info	Please fill out this column
Ticket(s) this relates to (not addresses)	#775 #742

---

Description of contribution in a few bullet points

• Added doc8 as a linting standard for checking .rst files. This is popularly used in conjunction with Sphinx websites to ensure their correctness.

• The current ruleset has fixed the following issues with the repository:

  • Fixed invalid rst formatting, which handles malformed tables, language specification in code blocks, etc.
  • Removed Windows-style carriage returns, ensuring consistent formatting across files.
  • Ensured spaces formatting over tabs.

Describe how this change was tested

• Performed linting validation using pre-commit run --all
• A base sanity check was done by verifying the build using make html and opening the _build/html/index.html file in a browser window.

[SteveMacenski]

Enforced a line length 200 for developer readability (this does not affect the website).

Can we remove this one? Sentences are more expressive than code & I would really like to not overly burden contributors with styling that is unimportant for the website. The other items I agree would be great.

[leander-dsouza]

Enforced a line length 200 for developer readability (this does not affect the website).

Can we remove this one? Sentences are more expressive than code & I would really like to not overly burden contributors with styling that is unimportant for the website. The other items I agree would be great.

Yes, sure.
I have dropped the line-length rule and have enforced the rest.

[SteveMacenski]

Otherwise LGTM!