Skip to content

Clean up the API documentation so it properly links to the code#791

Merged
katiebreivik merged 11 commits into
COSMIC-PopSynth:developfrom
TomWagg:api
May 29, 2026
Merged

Clean up the API documentation so it properly links to the code#791
katiebreivik merged 11 commits into
COSMIC-PopSynth:developfrom
TomWagg:api

Conversation

@TomWagg
Copy link
Copy Markdown
Collaborator

@TomWagg TomWagg commented May 29, 2026

This adds several docs pages with the API for all of the functions.

I also added the logo to the main and about pages.

@TomWagg TomWagg requested a review from katiebreivik May 29, 2026 17:20
@TomWagg TomWagg self-assigned this May 29, 2026
@TomWagg TomWagg added the docs Improvements to the documentation label May 29, 2026
@github-actions github-actions Bot added the needs-cmc-review PR touches cosmic core settings and needs CMC review label May 29, 2026
@github-actions
Copy link
Copy Markdown
Contributor

🚨 CMC review requested

This pull request modifies one or more of:

  • src/cosmic/evolve.py
  • src/cosmic/data/cosmic-settings.json (only flagged when category: "bse" key-count changes)

Trigger: evolve file changed, probably needs CMC review

A CMC developer should review this PR to ensure corresponding changes are propagated upstream as needed.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 29, 2026

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 76.31%. Comparing base (8772c07) to head (4cd3c28).
⚠️ Report is 163 commits behind head on develop.

Files with missing lines Patch % Lines
src/cosmic/evolve.py 0.00% 1 Missing ⚠️
src/cosmic/sample/cmc/elson.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##           develop     #791       +/-   ##
============================================
- Coverage    86.91%   76.31%   -10.60%     
============================================
  Files           40       58       +18     
  Lines        25542    28097     +2555     
  Branches         0      919      +919     
============================================
- Hits         22198    21440      -758     
- Misses        3344     6353     +3009     
- Partials         0      304      +304     

☔ 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.

Comment thread docs/conf.py Outdated
@katiebreivik
Copy link
Copy Markdown
Collaborator

👍

@katiebreivik katiebreivik merged commit 863b06d into COSMIC-PopSynth:develop May 29, 2026
4 of 6 checks passed
@TomWagg TomWagg deleted the api branch May 29, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements to the documentation needs-cmc-review PR touches cosmic core settings and needs CMC review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants