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: linked mkdocs & api docs #3703

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs: linked mkdocs & api docs #3703

wants to merge 8 commits into from

Conversation

ccmao1130
Copy link
Contributor

@ccmao1130 ccmao1130 commented Jan 17, 2025

Now all the User Guide content will be hosted on mkdocs and all the API Docs remain on sphinx docs

Dependencies to install to run locally: (cc @RCHowell)
pip install mkdocs-material (<- this one will automatically install pymdown-extensions)
pip install markdown-exec
pip install mkdocs-jupyter
pip install mkdocs-macros-plugin
pip install mkdocs-simple-hooks

mkdocs build will build both docs

  • link all methods in user guide with relative path

@github-actions github-actions bot added the docs label Jan 17, 2025
Copy link

codspeed-hq bot commented Jan 17, 2025

CodSpeed Performance Report

Merging #3703 will degrade performances by 29.7%

Comparing docs-rebuild (0c90db2) with main (6b302af)

Summary

❌ 1 regressions
✅ 26 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main docs-rebuild Change
test_iter_rows_first_row[100 Small Files] 193.5 ms 275.2 ms -29.7%

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.94%. Comparing base (5549d16) to head (0c90db2).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3703      +/-   ##
==========================================
+ Coverage   77.73%   77.94%   +0.21%     
==========================================
  Files         726      725       -1     
  Lines       91096    90952     -144     
==========================================
+ Hits        70811    70894      +83     
+ Misses      20285    20058     -227     

see 22 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant