get make docs-html working
#11830
Merged
get make docs-html working
#11830
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cmbz
added
FY26 Sprint 6
This was referenced Sep 25, 2025
pdurbin
force-pushed
the
11829-make-docs-html
branch
from
0dbb104 to
892193c
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the make docs-html command that was broken after adding Sphinx-Substitution-Extensions in #11477. The issue was that the Makefile's grep pattern for extracting the Sphinx version was too broad, matching multiple packages instead of just Sphinx itself.
- Updated the grep pattern in the Makefile to be more specific when extracting the Sphinx version
- Added a comment explaining the rationale for the more specific search pattern
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
jp-tosca
approved these changes
Oct 1, 2025
Contributor
jp-tosca
left a comment
jp-tosca
left a comment
There was a problem hiding this comment.
Looks good, sent an update on the branch.
github-project-automation
bot
moved this from In Review 🔎
to Ready for QA ⏩
in IQSS Dataverse Project
github-project-automation
bot
moved this from Ready for QA ⏩
to Merged 🚀
in IQSS Dataverse Project
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
We advertise
make docs-htmlas a way to build the guides at https://guides.dataverse.org/en/6.7.1/contributor/documentation.html#building-the-guides-with-a-sphinx-docker-container-and-a-makefileIt stopped working when we added in Sphinx-Substitution-Extensions in #11477.
Which issue(s) this PR closes:
make docs-htmldoesn't work #11829Special notes for your reviewer:
None.
Suggestions on how to test this:
Try it.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
I don't think so.
Additional documentation:
None.
Related: