Update Docs

[shyamd]

This PR updates the documentation structure to autogenerate the navigation for the API docs. This also adds the first version of the autogenerated changelog.

[codecov]

Codecov Report

Merging #295 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #295   +/-   ##
=======================================
  Coverage   90.05%   90.05%           
=======================================
  Files          54       54           
  Lines        2273     2273           
=======================================
  Hits         2047     2047           
  Misses        226      226           

Flag	Coverage Δ
#unittests	90.05% <ø> (ø)

---

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 8651cd5...07dd779. Read the comment docs.

[shyamd]

Just realized the changelog is pointing to my fork. Let me fix that first.

[CasperWA]

Just realized the changelog is pointing to my fork. Let me fix that first.

I think for this week we should try to not use our own forks (unless you feel more comfortable doing this). But it makes it much easier to quickly retrieve a branch and contribute to it, if needed, before merging.
We should mention this in the presentation shortly as well (@ml-evs) :)

[shyamd]

Ah! I'm so used to using my fork, that I didn't even think about that. I have updated the changelog. This should be good to merge if the tests all pass.

[ml-evs]

Happy to accept this for a squash merge, would be good to merge this soon so we can continue iterating on it.

[ml-evs]

Looks like the deployment failed somehow, I don't see any updates on the gh_pages branch from this PR

[shyamd]

It's actually set to just update docs on publishing a new package. We can manually push docs by running mkdocs gh-deploy while on the main repo git. In the future, we'll want to protect that branch and make it so only the github workflow can push to it.

[shyamd]

Just pushed the docs. Changes should be visible shortly

[ml-evs]

I see it all now, great. Couple of comments:

• the generated changelog seems to include issues that are in progress, e.g. running both servers as standard? It also doesn't include this PR, so what rules does it use to decide what to include?
• is there no way to have versioned docs with mkdocs? I guess as we're not using an external service, we'd have to put in the legwork...
• the API docs don't seem to render in rst (see e.g. https://www.optimade.org/optimade-python-tools/reference/server/mappers/entries/#optimade.server.mappers.entries.BaseResourceMapper)

[ml-evs]

Actually I'll raise this as a new issue, though I fear you might be the only one qualified to fix it :P