Skip to content
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

Documentation #58

Merged
merged 24 commits into from
Feb 10, 2024
Merged

Documentation #58

merged 24 commits into from
Feb 10, 2024

Conversation

jatkinson1000
Copy link
Owner

@jatkinson1000 jatkinson1000 commented Feb 3, 2024

Closes #50

Provides documentation build using sphinx.

  • Set up basic docs build using sphinx
  • Run through all code ensuring docstrings are accurate and up to date, add examples as required.
  • Add additional pages as required
  • Add docs dependencies to pyproject.toml (sphinx, sphinx_rtd_theme, sphinx-toolbox)
  • Set up workflow to deploy to personal github io
  • Workflow to check docs build
  • deploy to Read the Docs

@jatkinson1000 jatkinson1000 self-assigned this Feb 3, 2024
@jatkinson1000 jatkinson1000 added the documentation Improvements or additions to documentation label Feb 3, 2024
@jatkinson1000 jatkinson1000 added this to the First Release to PyPI milestone Feb 3, 2024
Copy link

codecov bot commented Feb 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (78ca54b) 95.45% compared to head (14b73b1) 95.45%.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #58   +/-   ##
=======================================
  Coverage   95.45%   95.45%           
=======================================
  Files          24       24           
  Lines        1321     1321           
=======================================
  Hits         1261     1261           
  Misses         60       60           
Files Coverage Δ
...utils/classifications/agb_field_classifications.py 98.50% <ø> (ø)
...tils/classifications/agb_indoor_classifications.py 98.43% <ø> (ø)
.../classifications/agb_old_indoor_classifications.py 97.91% <ø> (ø)
...ils/classifications/agb_outdoor_classifications.py 99.15% <100.00%> (ø)
...cheryutils/classifications/classification_utils.py 90.38% <ø> (ø)
archeryutils/constants.py 100.00% <ø> (ø)
archeryutils/handicaps/handicap_equations.py 100.00% <ø> (ø)
archeryutils/handicaps/handicap_functions.py 82.74% <100.00%> (ø)
archeryutils/rounds.py 100.00% <100.00%> (ø)
archeryutils/targets.py 100.00% <100.00%> (ø)

@jatkinson1000 jatkinson1000 merged commit 1c7a62c into main Feb 10, 2024
11 checks passed
@jatkinson1000 jatkinson1000 deleted the documentation branch February 10, 2024 16:44
@jatkinson1000 jatkinson1000 mentioned this pull request Feb 11, 2024
@jakharkaran jakharkaran mentioned this pull request Mar 21, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
1 participant