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: new documentation with mkdocs #527

Merged
merged 50 commits into from
Feb 24, 2023
Merged

Conversation

tlambert03
Copy link
Member

@tlambert03 tlambert03 commented Dec 12, 2022

I've very much enjoyed/preferred my experiences working with mkdocs, mkdocstrings, and the mkdocs-material theme. This PR converts the docs here to use mkdocs... it also dramatically reorganizes things to make usage patterns clearer;

edit ... really, this is a complete rewrite of pretty much every page 😂

@codecov
Copy link

codecov bot commented Dec 12, 2022

Codecov Report

Base: 89.86% // Head: 89.65% // Decreases project coverage by -0.22% ⚠️

Coverage data is based on head (62e3bcf) compared to base (0bb5323).
Patch coverage: 93.44% of modified lines in pull request are covered.

❗ Current head 62e3bcf differs from pull request most recent head 9d58412. Consider uploading reports for the commit 9d58412 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #527      +/-   ##
==========================================
- Coverage   89.86%   89.65%   -0.22%     
==========================================
  Files          39       37       -2     
  Lines        4442     4417      -25     
==========================================
- Hits         3992     3960      -32     
- Misses        450      457       +7     
Impacted Files Coverage Δ
src/magicgui/schema/_guiclass.py 96.66% <ø> (-1.12%) ⬇️
src/magicgui/tqdm.py 94.73% <ø> (ø)
src/magicgui/widgets/_table.py 96.14% <ø> (ø)
src/magicgui/widgets/bases/__init__.py 100.00% <ø> (ø)
src/magicgui/widgets/bases/_categorical_widget.py 80.28% <ø> (-4.23%) ⬇️
src/magicgui/widgets/bases/_create_widget.py 93.93% <ø> (ø)
src/magicgui/widgets/bases/_ranged_widget.py 89.14% <ø> (ø)
src/magicgui/widgets/bases/_slider_widget.py 96.87% <ø> (ø)
src/magicgui/widgets/protocols.py 100.00% <ø> (ø)
src/magicgui/_util.py 80.70% <90.90%> (+6.05%) ⬆️
... and 16 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@alisterburt
Copy link

It's amazing how good docs really make things crystallise in your mind - genuinely so psyched on guiclass and can't wait to use it :)

@tlambert03 tlambert03 enabled auto-merge (squash) February 24, 2023 01:05
@tlambert03 tlambert03 merged commit 3f412c7 into pyapp-kit:main Feb 24, 2023
@tlambert03 tlambert03 deleted the mkdocs branch February 24, 2023 01:05
@tlambert03 tlambert03 added the documentation Improvements or additions to documentation label Feb 24, 2023
@TimMonko
Copy link

All the new documentation is SOOO much better! (wish it was here 2 months ago haha!) Thank you so so much for all the work put into this! The logic, the flow, the extent of detail. Even after all I've learned this year with magicgui, this documentation is so much easier to navigate, clears up some sticking points I had, and more. I won't be missing the old docs. Cheers!

@tlambert03
Copy link
Member Author

Made my day, thanks for stopping by to leave a note

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.

None yet

4 participants