-
Notifications
You must be signed in to change notification settings - Fork 2
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
First version of the documentation #9
Open
HealthyPear
wants to merge
24
commits into
main
Choose a base branch
from
documentation-start
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
- add documentation optional dependencies - add a 'dev' extra with black, ruff, test and docs dependencies
- expose API for documentation - add docstrings to global variables - fix docstring for classes using private bkg_maps class attribute
- expose argument parser for use with sphinx-argparse
- added badges for CI and test coverage - small editorial changes regarding format and grammar
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #9 +/- ##
===========================================
- Coverage 100.00% 0.29% -99.71%
===========================================
Files 2 6 +4
Lines 3 685 +682
===========================================
- Hits 3 2 -1
- Misses 0 683 +683
☔ View full report in Codecov by Sentry. |
Specify location of html_static_path Disable Sphinx html_static_path
d1941a5
to
97ca73a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
This PR sets up the first version of the documentation based on Sphinx.
Details about the docs
Changes to other parts of the package
Deployment