Skip to content

docs: significant upgrade of documentation#271

Merged
steven-murray merged 15 commits intomainfrom
fix-docs
Mar 18, 2026
Merged

docs: significant upgrade of documentation#271
steven-murray merged 15 commits intomainfrom
fix-docs

Conversation

@steven-murray
Copy link
Collaborator

A significant upgrade of the documentation.

  • Made the README much leaner -- simply pointing to the documentation pages where possible.
  • Use the furo theme
  • Use sphinx-autoapi instead of autodoc
  • Update some outdated installation/developer documentation
  • More badges

@steven-murray steven-murray self-assigned this Mar 17, 2026
@steven-murray steven-murray added the type: maint: documentation Improvements or additions to documentation label Mar 17, 2026
@codecov
Copy link

codecov bot commented Mar 17, 2026

Codecov Report

❌ Patch coverage is 96.94656% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.72%. Comparing base (2354c9e) to head (88b78fb).
⚠️ Report is 16 commits behind head on main.

Files with missing lines Patch % Lines
src/hmf/cosmology/growth_factor.py 94.93% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #271      +/-   ##
==========================================
- Coverage   97.72%   97.72%   -0.01%     
==========================================
  Files          26       26              
  Lines        2639     2633       -6     
==========================================
- Hits         2579     2573       -6     
  Misses         60       60              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@steven-murray steven-murray merged commit 3c76888 into main Mar 18, 2026
20 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: maint: documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant