Skip to content

Add docs#10

Merged
ethanholz merged 8 commits intoomsf:mainfrom
dwhswenson:docs
Apr 16, 2025
Merged

Add docs#10
ethanholz merged 8 commits intoomsf:mainfrom
dwhswenson:docs

Conversation

@dwhswenson
Copy link
Copy Markdown
Member

Sphinx-based documentation.

There's certainly more content to add in the docs, but this will at least put in the framework (and a lot of the most important content).

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.29%. Comparing base (604af81) to head (bf40fa8).
Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #10   +/-   ##
=======================================
  Coverage   99.29%   99.29%           
=======================================
  Files          15       15           
  Lines         853      853           
=======================================
  Hits          847      847           
  Misses          6        6           

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

@dwhswenson dwhswenson requested a review from Copilot April 15, 2025 14:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 6 out of 17 changed files in this pull request and generated 1 comment.

Files not reviewed (11)
  • docs/Makefile: Language not supported
  • docs/cli.rst: Language not supported
  • docs/index.rst: Language not supported
  • docs/make.bat: Language not supported
  • docs/reference/cli.rst: Language not supported
  • docs/reference/filters.rst: Language not supported
  • docs/reference/index.rst: Language not supported
  • docs/reference/main.rst: Language not supported
  • docs/reference/output.rst: Language not supported
  • docs/reference/sources.rst: Language not supported
  • docs/reference/utils.rst: Language not supported

Comment thread src/spec0/releasefilters.py Outdated
Co-authored-by: Copilot <[email protected]>
@dwhswenson
Copy link
Copy Markdown
Member Author

I don't think RTD will actually build until we've got the .readthedocs.yaml file on the main branch. But I have, in principle, set up RTD for this repo. I'd debug any RTD-specific build issues (and set up the RTD build as a check on a PR) after this gets merged.

@dwhswenson dwhswenson requested a review from ethanholz April 15, 2025 14:31
@ethanholz ethanholz merged commit f56c4e9 into omsf:main Apr 16, 2025
5 checks passed
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