Fix documentation #155
Merged
Fix documentation #155
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
added 2 commits
October 13, 2023 18:15
Signed-off-by: Samuel Giffard <[email protected]>
This would otherwise output Sphinx errors. Signed-off-by: Samuel Giffard <[email protected]>
added 2 commits
October 13, 2023 18:41
This brings auto-documentation to remove redundancy. Signed-off-by: Samuel Giffard <[email protected]>
Copyright should never be in a docstring but in a comment. The difference is that docstrings are picked up by autodoc, whereas comments are left out. Signed-off-by: Samuel Giffard <[email protected]>
Mulugruntz
force-pushed
the
sgiffard/documentation
branch
from
c6b24cc to
e040be5
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #155 +/- ##
==========================================
+ Coverage 72.49% 72.64% +0.15%
==========================================
Files 35 36 +1
Lines 4035 4058 +23
==========================================
+ Hits 2925 2948 +23
Misses 1110 1110 ☔ View full report in Codecov by Sentry. |
|
Okay, this is not 100% complete. But it's already a HUGE improvement and work on what already exists. |
Signed-off-by: Samuel Giffard <[email protected]>
Mulugruntz
force-pushed
the
sgiffard/documentation
branch
from
72459b8 to
e85d904
Compare
sphinx 5 or greater is needed by sphinx-rtd-theme https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-dependencies
Prime541
approved these changes
Feb 12, 2024
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.
Why this way
I noticed the
docs/, which seems to not be generated from ourREADME.rst, even though it's a copy paste of it. (duplicates stuff).That means that even though I fixed the links in a previous PR, this was not reflected on our docs website.
There was no process for that so far and it was just copy/pasting until now.
To do