Documentation adjustments

[Zeitsperre]

Pull Request Checklist:

• This PR addresses an already opened issue (for bug fixes / features)
  • This PR fixes #xyz
• Tests for the changes have been added (for bug fixes / features)
  • (If applicable) Documentation has been added / updated (for bug fixes / features)
• HISTORY.rst has been updated (with summary of main changes)
  • Link to issue (:issue:number) and pull request (:pull:number) has been added

What kind of change does this PR introduce?

• Links the README.rst directly into the sphinx documentation so that we only need to update our front matter in one file
• Changes our badge layout for better readability
• Modifies the toctree in conf for better section layout
• Some small changes applied to section titles
• pre-commit autoupdate run
• Adds nbqa to the dev requirements for running black over notebooks

Does this PR introduce a breaking change?

Somewhat. nbqa is added as a dev requirement for make lint recipe.

Other information:

[aulemahal]

Theses changes look good to me!

Sphinx is having some difficulties on RTD though, strange since your changes are quite small...

[coveralls]

Coverage remained the same at 92.202% when pulling 26be037 on readme_changes into 87dac2b on master.

[Zeitsperre]

Problem finally solved:

It turns out that sphinx linkcheck launches requests for all the contents of every link that is requested, therefore any links to pages with lots of hyperlinks and elements will be very heavy. This is solved for us here by ignoring links on the ReadMe, which is fine.

Will perform a squash commit to remove the awful history here once build clears.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB