Clean up documentation and deploy automatically - #453
Open
epretti wants to merge 5 commits into
Open
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-pagesbranch will also need to be set up so the action has somewhere to push to.