Skip to content

read the docs check/build actions #144

@robfitzgerald

Description

@robfitzgerald

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions