Add support for generating multiversion documentation#949
Merged
Conversation
Parth (parth-07)
force-pushed
the
MultiversionDocs
branch
4 times, most recently
from
March 18, 2026 10:12
b5640a0 to
fb611ce
Compare
Contributor
|
Waiting to see this |
Parth (parth-07)
force-pushed
the
MultiversionDocs
branch
2 times, most recently
from
March 27, 2026 10:09
895f276 to
184b5b7
Compare
Parth (parth-07)
marked this pull request as ready for review
March 27, 2026 10:09
Parth (parth-07)
changed the title
Contributor
Author
I have hosted the multiversion documentation here https://parth-07.github.io/eld/ (displays the |
Parth Arora (partaror)
requested review from
quic-areg and
Shankar Easwaran (quic-seaswara)
March 30, 2026 05:37
This commit add supports for generating multiversion documentation. The
new targets added that enable this functionality are:
- `eld-docs-<release>` // <release> can be one of the releases such as
// 22.x, and main.
- `eld-docs-all-releases` // Builds all releases
- `eld-docs-assemble` // Combines all the version documentation and
// generates the version selector page.
- `eld-docs-multiversion` // eld-docs-all-releases + eld-docs-assemble
`eld-docs-<release>` creates the documentation by creating an eld
worktree in ${BUILD_DIR}/tools/eld/docs/multiversion/_work/${release}
with the requested release checked out. Please note that we cannot use
the original source repository to generate documentations of different
releases.
In the generated docs:
- the homepage ('/'), and '/main' will display the 'main'
documentation.
- '/22.x' and '/stable' will display the 'release/22.x' documentation.
- '/versions.html' will display a basic documentation version selector
menu.
Signed-off-by: Parth Arora <partaror@qti.qualcomm.com>
Parth (parth-07)
force-pushed
the
MultiversionDocs
branch
from
March 31, 2026 12:39
184b5b7 to
c93fdc4
Compare
Parth Arora (partaror)
approved these changes
Mar 31, 2026
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
3 participants
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 commit add supports for generating multiversion documentation. The
new targets added that enable this functionality are:
eld-docs-<release>// can be one of the releases such as 22.x, and main.eld-docs-all-releases// Builds all releaseseld-docs-assemble// Combines all the version documentation and generates the version selector page.eld-docs-multiversion// eld-docs-all-releases + eld-docs-assembleeld-docs-<release>creates the documentation by creating an eldworktree in ${BUILD_DIR}/tools/eld/docs/multiversion/_work/${release}
with the requested release checked out. Please note that we cannot use
the original source repository to generate documentations of different
releases.
In the generated docs:
/), and/mainwill display themainbranchdocumentation.
/22.xand/stablewill display therelease/22.xbranch documentation./versions.htmlwill display a basic documentation version selectormenu.
I have hosted the multiversion documentation here https://parth-07.github.io/eld/ to help with reviewing the functionality.
Version selector page: https://parth-07.github.io/eld/versions.html.