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

Removing use of deprecated alias of VersionChange #297

Merged
merged 1 commit into from
Nov 27, 2024

Conversation

rptb1
Copy link
Member

@rptb1 rptb1 commented Nov 26, 2024

Deprecated alias sphinx.directives.other.VersionChange was removed in Sphinx 8 https://www.sphinx-doc.org/en/master/changes/8.0.html#release-8-0-0-released-jul-29-2024 and this breaks the manual build.

This also breaks manual builds on Read The Docs, e.g. https://readthedocs.org/projects/memory-pool-system/builds/26405165/

Update to the recommended sphinx.domains.changeset.VersionChange.

@rptb1 rptb1 added the build Problems with builds and build automation label Nov 26, 2024
@rptb1 rptb1 self-assigned this Nov 26, 2024
@rptb1 rptb1 added the low risk This work is or would be of low risk of introducing defects. label Nov 27, 2024
@rptb1
Copy link
Member Author

rptb1 commented Nov 27, 2024

Executing proc.review.express.

  1. Start time 11:39.
  2. Applying entry.universal. Source documents are linked above. Applying entry.impl. Read The Docs build succeeded and output is visible.
  3. Calling in @thejayps . There will be a short delay.

Copy link
Member Author

@rptb1 rptb1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Executing proc.review.check.

  1. Start time 12:55.
  2. Checked out the branch and ensured I could build the manual with:
cd manual
make clean
rm -r tool
make html
  1. Checked the Sphinx version of the successful manual build with ./tool/bin/sphinx-build --version and got "sphinx-build 8.1.3" which matches the version run by Read the Docs.
  2. Checking finished 12:59.

Copy link
Contributor

@thejayps thejayps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checking - no defects found after 6 minutes

@rptb1
Copy link
Member Author

rptb1 commented Nov 27, 2024

Continuing proc.review.express.
4. proc.review.express.brainstorm: This is another software rot defect that would be caught earlier by fixing #294 . Was there a deprecation warning from Sphinx that we missed?
5. proc.review.exit.pass: Change passed.
6. proc.review.exit.calc: About 40 minutes used.

Copy link
Contributor

@thejayps thejayps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rptb1 has done exit.pass

@rptb1 rptb1 merged commit 7c52cfd into master Nov 27, 2024
9 of 15 checks passed
@rptb1
Copy link
Member Author

rptb1 commented Nov 27, 2024

Executing proc.merge.pull-request.

  1. Start time 13:12.
  2. Using the GitHub merge button instead of section 5, "Merging procedure" because this is a one-commit change with low risk and I already built the branch during checking.
  3. End time 13:14.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Problems with builds and build automation low risk This work is or would be of low risk of introducing defects.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants