Conversation
sphinx-docs.yml calls r-canon's reusable-sphinx.yml, which renders tuber's help topics into semantic Sphinx objects with rd2sphinx and builds them under sphinx-build -W --keep-going. All 73 exported objects get a page, and each is registered in objects.inv so other Sphinx projects can link into them. Deliberately no deploy: the pkgdown site stays the published one. Every run uploads the HTML as a tuber-furo-site artifact instead, which is what makes the two comparable before anyone decides whether to switch.
rd2sphinx now renders Rd bodies with R's own tools::Rd2HTML rather than translating them by hand, and no longer configures Furo's view-source and edit-this-page buttons. Those pointed at sphinx-docs/reference/*.rst, which is generated on every build and not in version control: the view link 404'd, and the edit link opened GitHub's create-a-new-file editor for a path that does not exist, which would have committed a build artifact.
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
sphinx-docs.ymlcalls r-canon's newreusable-sphinx.yml, which renderstuber's help topics into semantic Sphinx objects with
rd2sphinx and builds them under
sphinx-build -W --keep-going.The pkgdown site is untouched. There is deliberately no
deploy:on thisshim, so nothing races it for the Pages deployment. Every run uploads the HTML
as a
tuber-furo-siteartifact instead, which is what makes the two buildscomparable before anyone decides whether to switch.
What the build produces, run locally against this branch
include = "exports"-W --keep-goingNAMESPACE'sexport()directives have a page (checkedname by name, not counted)
objects.inv, including package-qualified forms such astuber::yt_search, so other Sphinx projects can link into tubergenindex.htmlandsearchindex.jspresentDepends on
gojiplus/r-canon#20, and resolves once
v2advances to include it.Blocked until then:
reusable-sphinx.yml@v2does not exist yet, so thisworkflow will fail to resolve on the first run.