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

Update chpldoc dependencies #24612

Merged
merged 10 commits into from
Apr 9, 2024
Merged

Update chpldoc dependencies #24612

merged 10 commits into from
Apr 9, 2024

Conversation

mppf
Copy link
Member

@mppf mppf commented Mar 13, 2024

This PR updates the chpldoc requirements to the newest versions. I tried this because I was thinking about adjustment to the search box, and I wanted to see if the newer versions of Sphinx behave differently. (They do not seem to).

Sphinx 7.2.6 requires Python >= 3.9, so this PR updates prereqs.rst to list 3.9 as required for chpldoc, start_test, and c2chapel. (The previous requirement for these was Python 3.7).

It adds the sphinx extension sphinxcontrib.jquery to conf.py because the search box from sphinx-rtd-theme now uses jquery.

package version before this PR version after this PR
MarkupSafe 2.1.3 2.1.5
Sphinx 5.3.0 7.2.6
urllib3 2.1.0 2.2.1
docutils 0.18 0.20.1
sphinxcontrib-chapeldomain 0.0.31 0.0.32

(note that chapel-lang/sphinxcontrib-chapeldomain#92 updated sphinxcontrib-chapeldomain in a coordinated manner: docutils 0.18 -> 0.20.1 and Sphinx 5.3.0 -> 7.2.6. The result of that PR is available in sphinxcontrib-chapeldomain version 0.0.32.)

Reviewed by @lydia-duncan - thanks!

  • full comm=none testing

@@ -33,6 +33,7 @@
# ones.
extensions = [
'sphinx.ext.todo',
'sphinxcontrib.jquery',
Copy link
Member Author

Choose a reason for hiding this comment

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

the search box from sphinx-rtd-theme now uses jquery

@mppf mppf removed the post-release label Apr 8, 2024
mppf added a commit to chapel-lang/sphinxcontrib-chapeldomain that referenced this pull request Apr 8, 2024
This is to go along with
chapel-lang/chapel#24612 . The changes to
test/test_chapeldomain.py avoid a problem when using docutils 0.19 or
newer that came up with the way the test was using mocked objects.

Reviewed by @lydia-duncan - thanks!
@mppf mppf marked this pull request as ready for review April 9, 2024 13:47
mppf added 7 commits April 9, 2024 09:49
---
Signed-off-by: Michael Ferguson <[email protected]>
to avoid errors like

.../compiler-internals/libraries.rst:11: WARNING: undefined label: 'LibraryFile_8h'

---
Signed-off-by: Michael Ferguson <[email protected]>
it was temporarily disabled in PR chapel-lang#24201

---
Signed-off-by: Michael Ferguson <[email protected]>
---
Signed-off-by: Michael Ferguson <[email protected]>
---
Signed-off-by: Michael Ferguson <[email protected]>
@mppf mppf force-pushed the chpldoc-sphinx-7 branch from 3d78892 to 29f4cb2 Compare April 9, 2024 13:49
mppf added 3 commits April 9, 2024 09:55
---
Signed-off-by: Michael Ferguson <[email protected]>
The PREDIFF stopped working because newer Sphinx does not
start the record with URL_ROOT.

---
Signed-off-by: Michael Ferguson <[email protected]>
@mppf mppf requested a review from lydia-duncan April 9, 2024 15:31
Copy link
Member

@lydia-duncan lydia-duncan left a comment

Choose a reason for hiding this comment

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

Really really minor suggestions, thanks for running with this!

frontend/doc/doxygen-pitfalls.txt Show resolved Hide resolved
@mppf mppf changed the title Upgrade chpldoc to Sphinx 7 Update chpldoc dependencies Apr 9, 2024
@mppf mppf merged commit 985649f into chapel-lang:main Apr 9, 2024
7 checks passed
@mppf mppf deleted the chpldoc-sphinx-7 branch April 9, 2024 18:43
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.

2 participants