Skip to content

Conversation

loriab
Copy link
Member

@loriab loriab commented Jun 14, 2022

Todos

  • Add a GHA to build the docs for every PR
    • gives us advance warning if the docs break, rather than having to watch master
    • advance warning is particularly necessary since the warnings-to-errors and nitpicky flags are on. these make sure links (functions, options, etc) aren't dead and that lists don't end up as mushed text.
    • unlike GHA automate docs build for PRs #2364, this isn't ambitious by building a website preview and writing a comment to the PR. but it does provide a tarball of the docs as a GHA artifact, so you can download, unpack, and view it locally in a browser. this happens whether the build succeeds or fails.
    • the new docs-pr.yml file looks so close to docs.yml, that you could argue for merging them. However, I think they could develop differently, with the master one also doing samples commits and auto-formatting, while the PR one does linting like add-a-comment-to-that-test or reformat warnings.
  • a filesystem.py file could be easily replaced by pathlib

Checklist

Status

  • Ready for review
  • Ready for merge

@loriab loriab changed the title WIP: docs-pr Check Docs Build for PRs in CI Jun 14, 2022
@loriab loriab added this to the Psi4 1.7 milestone Jun 14, 2022
@jturney jturney merged commit b874356 into psi4:master Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants