Cleaning up docs build

[isaacgsmith]

Description

• Generates ZENODO.rst by hooking into sphinx.
• Adds generated files to .gitignore.
• Formatting conf.py with black.

Motivation and context

Makes sure TARDIS is following best practices. See the discussion on #1757 for more context.

How has this been tested?

• Testing pipeline.
• Other.
  Docs built locally and on github.

Examples

https://smithis7.github.io/tardis/branch/conf_format_doc/index.html

Type of change

• Bug fix.
• New feature.
• Breaking change.
• None of the above.
  Formatting.

Checklist

• My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • (optional) I have built the documentation on my fork following the instructions.
• I have assigned and requested two reviewers for this pull request.

[tardis-bot]

Before a pull request is accepted, it must meet the following criteria:

• Is the necessary information provided?
• Is this a duplicate PR?
  • If a new PR is clearly a duplicate, ask how this PR is different from the original PR?
  • If this PR is about to be merged, close the original PR with a link to this new PR that solved the issue.
• Does it pass existing tests and are new tests provided if required?
  • The test coverage should not decrease, and for new features should be close to 100%.
• Is the code tidy?
  • No unnecessary print lines or code comments.

[sourcery-ai]

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 0.79%.

Quality metrics	Before	After	Change
Complexity	3.42 ⭐	3.36 ⭐	-0.06 👍
Method Length	98.43 🙂	87.62 🙂	-10.81 👍
Working memory	9.34 🙂	9.13 🙂	-0.21 👍
Quality	59.04% 🙂	59.83% 🙂	0.79% 👍

Other metrics	Before	After	Change
Lines	374	397	23

Changed files	Quality Before	Quality After	Quality Change
docs/conf.py	59.04% 🙂	59.83% 🙂	0.79% 👍

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
docs/conf.py	create_redirect_files	3 ⭐	94 🙂	10 😞	66.84% 🙂	Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

• ⭐ excellent
• 🙂 good
• 😞 poor
• ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

---

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

[codecov]

Codecov Report

Merging #1801 (19eb1e5) into master (efebacd) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1801   +/-   ##
=======================================
  Coverage   58.25%   58.25%           
=======================================
  Files          66       66           
  Lines        6721     6721           
=======================================
  Hits         3915     3915           
  Misses       2806     2806           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update efebacd...19eb1e5. Read the comment docs.

[epassaro]

We do not format conf.py or any other package template file. But in this case maybe it's worth since we use that file a lot, I don't know. But certainly not in this PR, black formatting should be done in a separate PR and then added to the .git-blame-ignore-revs.

[isaacgsmith]

@epassaro sorry to make changes while you were reviewing. I had a docs failure so I just had to revert it back. I don't see the harm in doing the black formatting in this PR, I think it should be formatted correctly, and this seems as good of a PR as any to add that in, right?

[epassaro]

@epassaro sorry to make changes while you were reviewing. I had a docs failure so I just had to revert it back. I don't see the harm in doing the black formatting in this PR, I think it should be formatted correctly, and this seems as good of a PR as any to add that in, right?

https://akrabat.com/ignoring-revisions-with-git-blame/

[jaladh-singhal]

@smithis7 You've applied your organization skills excellently in code too - conf.py now looks a lot neater. Thanks for this PR other changes like gitignoring were required too!

I just have one small comment and then it's ready to be merged (do ping me when you push it so that I don't forget).

[jaladh-singhal]

Thanks for the update @smithis7 - ready to merge!