Skip to content

Fix RTD/GitHub configuration so PR RTD builds are reported on GitHub #573

Closed
@tsalo

Description

@tsalo

Summary

The build_docs CI step is done on CircleCI and takes ~20 minutes. CircleCI already has a bunch of jobs to run, so the docs-building step can block other jobs. Additionally, there have been times where the CircleCI build didn't match up with the RTD build.

Additional details

The main benefits are reduced testing time and better alignment between testing-generated docs and deployed (RTD) docs.

Next steps

  1. Look into an RTD Action and see if I can build it in PRs.
  2. Remove old CircleCI docs job.
  3. Add new Action.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImproving documentation for the projectimpact: lowEstimated low impact taskpriority: mediumEstimated medium priority tasktestingImproving testing in the project

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions