-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Docs #295
Update Docs #295
Conversation
# Conflicts: # .github/workflows/deps_lint.yml # .github/workflows/publish-on-pypi.yml # .github/workflows/requirements-docs.txt # mkdocs.yml
Codecov Report
@@ Coverage Diff @@
## master #295 +/- ##
=======================================
Coverage 90.05% 90.05%
=======================================
Files 54 54
Lines 2273 2273
=======================================
Hits 2047 2047
Misses 226 226
Continue to review full report at Codecov.
|
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. |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to accept this for a squash merge, would be good to merge this soon so we can continue iterating on it.
Looks like the deployment failed somehow, I don't see any updates on the gh_pages branch from this PR |
It's actually set to just update docs on publishing a new package. We can manually push docs by running |
Just pushed the docs. Changes should be visible shortly |
I see it all now, great. Couple of comments:
|
Actually I'll raise this as a new issue, though I fear you might be the only one qualified to fix it :P |
This PR updates the documentation structure to autogenerate the navigation for the API docs. This also adds the first version of the autogenerated changelog.