Reorganize docs site: Sphinx docs at root, dashboard at /dashboard/ - #56
Closed
justinchuby wants to merge 2 commits into
Closed
Reorganize docs site: Sphinx docs at root, dashboard at /dashboard/#56justinchuby wants to merge 2 commits into
justinchuby wants to merge 2 commits into
Conversation
justinchuby
force-pushed
the
justinchu/docs-site-reorg
branch
from
March 28, 2026 03:57
b8e7e73 to
c020a1e
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the GitHub Pages site so Sphinx (Furo) documentation is served at the root URL and the testing confidence dashboard is served under /dashboard/.
Changes:
- Update the Pages workflow to build Sphinx into
_site/(root) and emit the dashboard into_site/dashboard/index.html. - Add a dashboard link to the docs landing page.
- Add a docs link in the dashboard header and rename the workflow to “Documentation”.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.github/workflows/pages.yml |
Swaps build outputs so Sphinx is deployed at the site root and dashboard is placed under /dashboard/. |
docs/index.md |
Adds a link from the docs homepage to the dashboard location. |
scripts/templates/dashboard.html.j2 |
Adds a header link back to the docs root from the dashboard. |
Move Sphinx documentation to the root URL (onnxruntime.github.io/mobius/) and the testing confidence dashboard to a sub-URL (onnxruntime.github.io/mobius/dashboard/). - Swap build order in pages.yml: sphinx-build to _site/, dashboard to _site/dashboard/ - Rename workflow from 'Dashboard' to 'Documentation' - Add dashboard link to docs index page - Add docs link to dashboard header Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
justinchuby
force-pushed
the
justinchu/docs-site-reorg
branch
from
March 28, 2026 03:59
c020a1e to
5aa6dfb
Compare
Performance Comparison
|
Move model page generation, feature-flags doc generation, and dashboard generation into Sphinx extensions under docs/_ext/. This consolidates the entire documentation build into a single sphinx-build invocation: - models_gen: builder-inited hook runs _generate_models.py - flags_gen: builder-inited hook runs _generate_flags_docs.py (conditional) - dashboard: build-finished hook runs generate_dashboard.py into /dashboard/ and creates /docs/ → / redirect Simplify pages.yml from 4 separate steps to 1 sphinx-build command. Signed-off-by: Justin Chu <justinchuby@users.noreply.github.com>
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
|
|
||
| from __future__ import annotations | ||
|
|
||
| import importlib |
Member
Author
|
Merged into PR #55 to consolidate overlapping changes (pages.yml, docs structure). |
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
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
Swap the GitHub Pages layout so Sphinx documentation is at the root URL and the dashboard moves to a sub-URL.
Before
onnxruntime.github.io/mobius/→ Dashboardonnxruntime.github.io/mobius/docs/→ Sphinx docsAfter
onnxruntime.github.io/mobius/→ Sphinx docs (Furo theme)onnxruntime.github.io/mobius/dashboard/→ Testing dashboardChanges
sphinx-build docs _site(root), dashboard to_site/dashboard/The dashboard is fully self-contained HTML (inline CSS/JS) so moving it to a subdirectory has no side effects.