Deploy documentation to GitHub Pages#1436
Open
bmehta001 wants to merge 1 commit intomicrosoft:mainfrom
Open
Conversation
The ReadTheDocs fix restored the Sphinx/Doxygen build, but the repository had no active workflow to publish that output to the github-pages environment. Add a Pages workflow that validates docs on PRs and deploys generated HTML from main pushes. Files changed: - .github/workflows/deploy-docs-pages.yml Co-authored-by: Copilot <[email protected]>
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.
Summary
docs/publicwith Sphinx, Exhale, Breathe, Doxygen, and Graphvizdocs/public/_build/htmlas a GitHub Pages artifact onmainpushesgithub-pagesenvironment with the official Pages actionsWhy
PR #1435 restored the Sphinx/Doxygen site build configuration, but after it merged there was still no repository workflow that published the generated HTML to GitHub Pages. The current
github-pagesdeployment records are stale failures from 2022 and no fresh deployment was created by the #1435 merge.Validation
.github/workflows/deploy-docs-pages.ymlas YAMLpython -m sphinx -q -b html docs/public docs/public/_build/htmlwith Doxygen on PATHdocs/public/_build/html/index.html