Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

read the docs check/build actions #144

Open
robfitzgerald opened this issue Mar 16, 2023 · 1 comment
Open

read the docs check/build actions #144

robfitzgerald opened this issue Mar 16, 2023 · 1 comment
Milestone

Comments

@robfitzgerald
Copy link
Collaborator

currently, we build our readthedocs content when testing a pull request. this means we push changes to readthedocs any time someone updates a commit on an active PR. since this is now an open source project, this means that a random github user could submit a PR with changes to our documentation and it would run the docs build process for them.

proposed change:

  1. copy the build action over to a push action (based on this comment)
  2. if sphinx supports a dry-run operation to test the validity of the docs: (on a cursory search of the docs i didn't find one)
    • change the current PR action so that it executes a dry run of building the docs, which at least confirms the validity of any docs changes
@robfitzgerald robfitzgerald added this to the nice-to-haves milestone Mar 16, 2023
@nreinicke
Copy link
Collaborator

We should confirm this, but I'm pretty sure that the PR action only pushes the documentation changes to a staging site, see here: https://nrelhive--143.org.readthedocs.build/en/143/ and not to the main documentation site until the PR is merged.

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

No branches or pull requests

2 participants