Add sphinx documentation #38
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #38 +/- ##
=======================================
Coverage 98.78% 98.78%
=======================================
Files 29 29
Lines 824 824
=======================================
Hits 814 814
Misses 10 10 Continue to review full report at Codecov.
|
|
@IgnisDa Will get that deployments, etc. configured this weekend. Thanks so much! I'll also contrib to docs! |
|
Hello @maxmorlocke when will this get merged? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #12
This is still a WIP.
@maxmorlocke It would be great if you configure the readthedocs settings and deploy the documentation. Meanwhile, I will try to write the documentation down.
TODO: Add github action to automatically deploy documentation to readthedocs.