This adds docs and the ability to auto-format the codebase. It goes one step further, however, and will make the CI fail if the code is not formatted as expected to ensure that we all play by the same rules (yes, they're probably not to everyone's taste but the consistency is more important than it being exactly the way we want).
Builds on:
[x] #90
Please confirm that this pull request has done the following:
[x] Tests added (N/A)
[x] Documentation added (where applicable)
[x] Example added (either to an existing notebook or as a new notebook, where applicable) (N/A)
[x] Description in CHANGELOG.rst added
Adding to CHANGELOG.rst
Please add a single line in the changelog notes similar to one of the following:
- (`#XX <http://link-to-pr.com>`_) Added feature which does something
- (`#XX <http://link-to-pr.com>`_) Fixed bug identified in (`#XX <http://link-to-issue.com>`_)
Pull request
This adds docs and the ability to auto-format the codebase. It goes one step further, however, and will make the CI fail if the code is not formatted as expected to ensure that we all play by the same rules (yes, they're probably not to everyone's taste but the consistency is more important than it being exactly the way we want).
Builds on:
Please confirm that this pull request has done the following:
CHANGELOG.rstaddedAdding to CHANGELOG.rst
Please add a single line in the changelog notes similar to one of the following: