Skip to content

Update Sphinx/sphinx-rtd-theme to 8.1.2 and 3.0.1, respectively#17285

Merged
seanbudd merged 5 commits into
nvaccess:masterfrom
josephsl:sphinx-rtd-theme-3.0.1
Oct 14, 2024
Merged

Update Sphinx/sphinx-rtd-theme to 8.1.2 and 3.0.1, respectively#17285
seanbudd merged 5 commits into
nvaccess:masterfrom
josephsl:sphinx-rtd-theme-3.0.1

Conversation

@josephsl

@josephsl josephsl commented Oct 11, 2024

Copy link
Copy Markdown
Contributor

Link to issue number:

Closes #17284

Summary of the issue:

NVDA project is using outdated Sphinx and sphinx-rtd-theme dependency.

Description of user facing changes

None

Description of development approach

Updated Sphinx and sphinx-rtd-theme to 8.1.2 and 3.0.1, respectively (did the latter first to ensure latest compatible Sphinx is picked up).

Testing strategy:

Manual testing:

  1. Update the dependencies.
  2. Run "scons devDocs" to make sure documentation is still readable.

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

@josephsl josephsl requested a review from a team as a code owner October 11, 2024 13:50
@josephsl josephsl requested a review from SaschaCowley October 11, 2024 13:50
@josephsl josephsl changed the title Update Sphinx/sphinx-rtd-theme to 8.1.0 and 3.0.1, respectively Update Sphinx/sphinx-rtd-theme to 8.1.2 and 3.0.1, respectively Oct 13, 2024
@AppVeyorBot

Copy link
Copy Markdown
  • PASS: Translation comments check.
  • PASS: License check.
  • PASS: Unit tests.
  • PASS: Lint check.
  • FAIL: System tests (tags: installer NVDA). See test results for more information.
  • Build (for testing PR): https://ci.appveyor.com/api/buildjobs/llo04sv5kjjkvu4i/artifacts/output/l10nUtil.exe nvda_snapshot_pr17285-34272,d3e105a8.exe
  • CI timing (mins):
    INIT 0.0,
    INSTALL_START 1.2,
    INSTALL_END 1.0,
    BUILD_START 0.0,
    BUILD_END 25.0,
    TESTSETUP_START 0.0,
    TESTSETUP_END 0.4,
    TEST_START 0.0,
    TEST_END 18.5,
    FINISH_END 0.2

See test results for failed build of commit d3e105a864

@seanbudd seanbudd merged commit e01caee into nvaccess:master Oct 14, 2024
@github-actions github-actions Bot added this to the 2025.1 milestone Oct 14, 2024
@josephsl josephsl deleted the sphinx-rtd-theme-3.0.1 branch October 28, 2024 04:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Sphinx/sphinx-rtd-theme: update Sphinx to 8.1.0 and sphinx-rtd-theme to 3.0.1

3 participants