Documentation should conform to that of the python-project template

[jmborr]

EWM 6302

Short description of the changes:

Long description of the changes:

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

Manual test for the reviewer

References

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (next@569ac33). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             next      #37   +/-   ##
=======================================
  Coverage        ?   82.36%           
=======================================
  Files           ?       20           
  Lines           ?     2280           
  Branches        ?        0           
=======================================
  Hits            ?     1878           
  Misses          ?      402           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.