PlasmaPy / PlasmaPy/plasmapy_sphinx

Test documentation builds against the development branch of Sphinx

Open
#26 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority: low
Dominant language
Python
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

We recently ran into some problems due to breaking changes in the release of Sphinx v9 (#23, #24, #25).

To make it easier to find and fix problems due to upstream breaking changes before they get released, it would be helpful to test building the plasmapy_sphinx docs against the development branch of Sphinx as part of CI. This would help us raise issues in upstream repositories so that extensions could get a head start on compatibility fixes too.

This is low priority since we have a workflow to test PlasmaPy documentation builds against the
development branches of Sphinx, plasmapy_sphinx, and a few other upstream dependencies. That workflow will let us know about breaking changes ahead of time, assuming I remember to pay attention to it. 😅 But, building the plasmapy_sphinx documentation using the development branch of Sphinx would make it easier to address breaking changes before they make it into an official release.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the existing CI workflow that builds the plasmapy_sphinx documentation and inspect how Sphinx dependencies are installed. Add coverage for the development branch of Sphinx, then verify that the documentation build runs successfully in CI and exposes upstream breaking changes.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.