CI to test successful docs build

Open
#7,075 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
github-actions, python
Domain
build-system, ci-cd, documentation

Research direction

Inspect the repository's existing CI configuration and documentation build entry points, then compare them with the Readthedocs process and its handling of lock files. Done means a single atomic CI job runs the docs build independently and fails when that build is unsuccessful.

Written by the indexing model from the issue text.

Description

Type: Documentation Type: Testing

📚 Documentation

We have some CI which currently relies on the docs build, but that won't always be the case - see https://github.com/SciTools/iris/issues/6110#issuecomment-3699202998. Meanwhile Readthedocs has its own custom docs build process, which does not respect the lock files.

We need some CI which has just one job - test the docs build. This keeps it atomic, and will fail fast.

Dominant language
Python
Stars
724
Forks
317
Avg merge
3d 20h
Merged PRs (30d)
9

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SciTools/iris

All issues in SciTools/iris

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.