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

Documentation: Bump docutils from 0.18.1 to 0.19 #14917

Merged
merged 1 commit into from
Nov 24, 2024

Conversation

lupyuen
Copy link
Member

@lupyuen lupyuen commented Nov 24, 2024

Summary

This PR bumps the version of docutils from 0.18.1 to 0.19, as requested by dependabot:

Impact

Documentation builds correctly. Dependency on tornado is no longer required after updating to docutils 0.19.

Testing

Tested OK by inspecting the Generated HTML at Documentation/_build/html/components/index.html

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Size: L The size of the change in this PR is large labels Nov 24, 2024
@lupyuen lupyuen force-pushed the tornado branch 2 times, most recently from a933543 to 6ec09b8 Compare November 24, 2024 02:29
@nuttxpr
Copy link

nuttxpr commented Nov 24, 2024

[Experimental Bot, please feedback here]

Fill In The Commit Message: This PR contains a Commit with an Empty Commit Message. Please fill in the Commit Message with the PR Summary.

Impact

  • Is new feature added? NO
  • Is existing feature changed? NO
  • Impact on user (will user need to adapt to change)? NO
  • Impact on build (will build process change)? Potentially YES. A newer version of docutils may have different build dependencies or require changes to the build system. This needs investigation and testing.
  • Impact on hardware (will arch(s) / board(s) / driver(s) change)? NO
  • Impact on documentation (is update required / provided)? Potentially YES. If the docutils update changes the generated documentation format or behavior, adjustments to the documentation source or build process may be needed. This should be checked.
  • Impact on security (any sort of implications)? Potentially YES. Version bumps often address security vulnerabilities. This should be reviewed in the docutils changelog.
  • Impact on compatibility (backward/forward/interoperability)? Potentially YES. The updated docutils version might have breaking changes that affect how NuttX documentation is generated. This must be tested.
  • Anything else to consider? Consider running the documentation build process and checking the resulting HTML for any changes or regressions.

Testing

TODO: This section needs actual testing results. You should build and test on at least one representative configuration before and after the change. Include the relevant build and test logs here. Consider testing the documentation build specifically. If you have encountered build issues, detail those here. Indicate the host and target environments used for testing (OS, architecture, compiler). For example:

  • Build Host(s): Linux (Ubuntu 22.04), x86_64, GCC 11.4
  • Target(s): sim:qemu-x86_64

Testing logs before change:

#  Provide commands used and their output. For example:
make distclean
./tools/configure.sh sim:qemu-x86_64
make
make doc
# ... (include relevant snippets from the build output and documentation generation)

Testing logs after change:

# Repeat the same commands as above after applying the patch
make distclean
./tools/configure.sh sim:qemu-x86_64
make
make doc
# ... (include relevant snippets from the build output and documentation generation)

This PR bumps the version of docutils from 0.18.1 to 0.19, as requested by dependabot:
- apache#14910
@lupyuen lupyuen marked this pull request as ready for review November 24, 2024 02:44
@xiaoxiang781216 xiaoxiang781216 merged commit 52ac991 into apache:master Nov 24, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation Size: L The size of the change in this PR is large
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants