Skip to content

Clean up documentation and deploy automatically - #453

Open
epretti wants to merge 5 commits into
openmm:mainfrom
epretti:docs
Open

Clean up documentation and deploy automatically#453
epretti wants to merge 5 commits into
openmm:mainfrom
epretti:docs

Conversation

@epretti

@epretti epretti commented Sep 4, 2026

Copy link
Copy Markdown
Member

Sets up GitHub Actions to automatically build and deploy the Sphinx documentation to GitHub Pages. This is mostly modeled after the way OpenMM-ML and MLIPOps do their documentation. It also moves a lot of material from the README that should have been in a user guide into an actual user guide.

I don't think this can easily be tested on this repository before we actually merge it to trigger the action. However, I've been testing it on my fork so the output can be previewed at https://epretti.github.io/openmmforcefields.

A gh-pages branch will also need to be set up so the action has somewhere to push to.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.48%. Comparing base (fb86b91) to head (5bd3af6).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #453   +/-   ##
=======================================
  Coverage   84.48%   84.48%           
=======================================
  Files           5        5           
  Lines         799      799           
=======================================
  Hits          675      675           
  Misses        124      124           

☔ View full report in Codecov by Harness.
📢 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.

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.

2 participants