Enable Precommit hook (darker/linting) and Updates to Docs

[trevormorgan]

Do not merge until #109 lands

• add precommit
• enable darker
• Update sphinx docs
• Add in examples to documentation

[codecov-commenter]

Codecov Report

Merging #110 (a22a739) into master (2875470) will increase coverage by 0.47%.
The diff coverage is 56.06%.

@@            Coverage Diff             @@
##           master     #110      +/-   ##
==========================================
+ Coverage   79.67%   80.15%   +0.47%     
==========================================
  Files          16       16              
  Lines        2367     2368       +1     
==========================================
+ Hits         1886     1898      +12     
+ Misses        481      470      -11     

Impacted Files	Coverage Δ
broadbean/plotting.py	0.00% <0.00%> (ø)
broadbean/broadbean.py	61.79% <37.50%> (ø)
broadbean/element.py	88.77% <57.14%> (ø)
broadbean/sequence.py	72.46% <58.33%> (+0.40%)	⬆️
broadbean/blueprint.py	89.18% <66.66%> (ø)
broadbean/__init__.py	100.00% <100.00%> (ø)
broadbean/tests/test_awgfilegeneration.py	98.57% <0.00%> (+2.85%)	⬆️
broadbean/_version.py	100.00% <0.00%> (+100.00%)	⬆️

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

[jenshnielsen]

@trevormorgan I think this is ready to merge. The final thing is to run the pre-commit hook and commit the changes.

 pre-commit run --all

[trevormorgan]

@trevormorgan I think this is ready to merge. The final thing is to run the pre-commit hook and commit the changes.

 pre-commit run --all

Thanks @jenshnielsen, updates due to the precommit run have been pushed. I added in some changes to documentation that should be reviewed as well. Mainly modernizing with nbsphinx in the conf.py and adding in the example notebooks to the index.rst

[jenshnielsen]

Now you will also need to adapt https://github.com/QCoDeS/broadbean/blob/master/.github/workflows/docs.yaml to actually call sphinx

[jenshnielsen]

I am not sure why the conda build requires versioningit. It should not since it installs a wheel that has already had the version number logic replaced

[trevormorgan]

I am not sure why the conda build requires versioningit. It should not since it installs a wheel that has already had the version number logic replaced

@jenshnielsen I'm a bit perplexed by this one as well. I haven't dug into much yet though so I'll see what I can find out.

[jenshnielsen]

I suggest that we simply get rid of it #139