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

Migrate to mkdocs #55

Merged
merged 3 commits into from
Jan 6, 2025
Merged

Migrate to mkdocs #55

merged 3 commits into from
Jan 6, 2025

Conversation

glass-ships
Copy link
Member

Migrates documentation to using mkdocs and mkdocstrings with the Read the Docs theme.

To test:

  • checkout the mkdocs branch
  • install/update conda environment to include mkdocs dependencies
  • run mkdocs serve

@glass-ships glass-ships requested a review from mdoucet January 6, 2025 18:38
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.85%. Comparing base (81e811a) to head (7a9231a).

Additional details and impacted files
@@            Coverage Diff             @@
##             next      #55      +/-   ##
==========================================
- Coverage   85.87%   85.85%   -0.03%     
==========================================
  Files          20       20              
  Lines        2478     2474       -4     
==========================================
- Hits         2128     2124       -4     
  Misses        350      350              

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

@mdoucet mdoucet merged commit 2b5423e into next Jan 6, 2025
1 check passed
@mdoucet mdoucet deleted the mkdocs branch January 6, 2025 21:56
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.

3 participants