Add sphinx docs #13
Merged
Add sphinx docs #13
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
Contributor
marcorossi5
commented
Dec 21, 2023
- Minimal sphinx package documentation
- Sphinx build with automatic workflow
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #13 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 112 114 +2
=========================================
+ Hits 112 114 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
scarrazza
reviewed
Dec 22, 2023
There was a problem hiding this comment.
@marcorossi5 thanks. Please find my comments above. Please rename docs in doc so the CI will work in case we perform tests directly in the sphinx documentation.
for more information, see https://pre-commit.ci
scarrazza
reviewed
Jan 2, 2024
Co-authored-by: Stefano Carrazza <scarrazza@users.noreply.github.com>
scarrazza
approved these changes
Jan 9, 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.