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

docs: setup documentation with mkdocs #84

Merged
merged 6 commits into from
Jan 10, 2025
Merged

Conversation

tlambert03
Copy link
Member

This adds documentation that we can build on. I don't want to spend too much time evaluating this specific PR. So will likely merge soon. but every part of this is open for subsequent refactoring. It includes a nice install table:

Screenshot 2025-01-10 at 11 45 45 AM

and complete API documentation:

Screenshot 2025-01-10 at 11 46 10 AM

@tlambert03 tlambert03 enabled auto-merge (squash) January 10, 2025 16:53
@tlambert03 tlambert03 merged commit 91eb422 into pyapp-kit:main Jan 10, 2025
50 checks passed
@tlambert03 tlambert03 deleted the mkdocs branch January 10, 2025 17:00
Copy link

codecov bot commented Jan 10, 2025

Codecov Report

Attention: Patch coverage is 88.46154% with 3 lines in your changes missing coverage. Please review.

Project coverage is 70.19%. Comparing base (48d06d4) to head (e5874ab).
Report is 23 commits behind head on main.

Files with missing lines Patch % Lines
src/ndv/views/_vispy/_histogram.py 0.00% 2 Missing ⚠️
src/ndv/views/_app.py 66.66% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #84      +/-   ##
==========================================
- Coverage   70.53%   70.19%   -0.34%     
==========================================
  Files          43       44       +1     
  Lines        4253     4255       +2     
==========================================
- Hits         3000     2987      -13     
- Misses       1253     1268      +15     

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

@tlambert03 tlambert03 mentioned this pull request Jan 12, 2025
4 tasks
@tlambert03 tlambert03 added the documentation Improvements or additions to documentation label Jan 17, 2025
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.

1 participant