docs: rework package file formats and doc generation#171
Open
threexc wants to merge 6 commits into
Open
Conversation
This makes python-wheels more consistent with the original package docs' pattern in wheel_builder. AI-Generated: Uses Claude Sonnet 5 Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
We were still using the old docs/source/packages path, rather than the docs/packages path in python-wheels. AI-Generated: Uses Claude Sonnet 5 Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Use simpler logic and the new proxy URL for the package registry when generating docs. AI-Generated: Uses Claude Sonnet 5 Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
These are generated for documentation deployment, but they shouldn't be committed to the repository anymore, only deployed by a workflow. Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
threexc
force-pushed
the
tgamblin/package-docs-rework
branch
from
4cd4b75 to
e73148b
Compare
|
threexc
force-pushed
the
tgamblin/package-docs-rework
branch
5 times, most recently
from
5912f4c to
18fde6e
Compare
Create a custom workflow for deploying our documentation to GitHub Pages. This allows us to retain the original YAML-to-documentation generation process we've used in the past, and stops us from relying solely on files already being on the main branch for documentation build and review. We have to incorporate two new community actions for this: 1. `peaceiris/actions-gh-pages`, for deploying the actual docs using a `gh-pages` branch 2. `rossjrew/pr-preview-action`, for creating docs previews so we're able to review the changes before merge. Comments will be posted on the PR providing preview links. The `gh-pages` branch also requires a `.nojekyll` file at the project root to avoid a manual rebuild, which can take a lot of time. Finally, the `Deploy from a branch` option in the Pages setting needs to point at `root/`, not `docs/` or it won't find the `.nojekyll` file. AI-Generated: Uses Claude Sonnet 5 Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
threexc
force-pushed
the
tgamblin/package-docs-rework
branch
from
18fde6e to
9418191
Compare
…rkflow Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
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.
This is a quick rework (with the assistance of Claude) to align our documentation with how we used to do it, i.e. using YAML files to track our version support and generating a docs page for each package from that. Along the way I caught a few issues with some outdated path logic in the
check_versions.pyandgenerate_packages_doc.pyscripts. With this change we don't need the Markdown files committed to the repository anymore, so those have been yanked in the same commit which added the YAML equivalents.On the repository infrastructure side, there's also a new
docs.ymlworkflow which handles generation and deployment. After this merges, a newgh-pagesbranch will be created and we'll correspondingly need change theBranchdrop-down inSettings -> Pages -> Build and Deploymentfrommaintogh-pagesfor this all to work. It should have the added benefit of letting us more easily review docs changes in PRs before they're merged.