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

Improve documentation #262

Merged
merged 14 commits into from
Jul 7, 2024
Merged

Improve documentation #262

merged 14 commits into from
Jul 7, 2024

Conversation

shunichironomura
Copy link
Owner

  • add poetry and ruff badges
  • add gen_index.py
  • remove index.md
  • configure gen-files scripts
  • Add linebreak
  • add gen_index_page to gen_pages.py
  • rename callback to build
  • update command.md
  • Update documentation for contexts/watchers/reporters
  • remove unnecessary import
  • change links
  • export CapsuleParams
  • add extending.md
  • add deploy-docs to release workflow

Copy link

codecov bot commented Jul 7, 2024

Codecov Report

Attention: Patch coverage is 69.23077% with 4 lines in your changes missing coverage. Please review.

Project coverage is 78.71%. Comparing base (3b4f510) to head (4c8c7f5).
Report is 1 commits behind head on main.

Files Patch % Lines
capsula/_capsule.py 0.00% 2 Missing ⚠️
capsula/_reporter/_base.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #262   +/-   ##
=======================================
  Coverage   78.71%   78.71%           
=======================================
  Files          29       29           
  Lines         996      996           
=======================================
  Hits          784      784           
  Misses        212      212           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shunichironomura shunichironomura merged commit bd8211f into main Jul 7, 2024
23 of 24 checks passed
@shunichironomura shunichironomura deleted the improve-docs-index branch July 7, 2024 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant