Repository navigation
Conversation
Implement the same documentation setup as QuasarApp/Heart#88: MkDocs with the Material theme serving the README as the home page and the Doxygen HTML output under /api/, deployed to the gh-pages branch by the 'Deploy Documentation (GitHub Pages)' workflow (Doxygen 1.18.0 + Graphviz installed in the workflow via marketplace actions, no system apt). - doxygen.conf renamed to doxygen.conf.in (generated file gitignored), the 15 tags rejected as obsolete by Doxygen 1.18 removed, PROJECT_NUMBER wired to VIEWSOLUTIONS_VERSION (1.0.<commits>.<sha>), PROJECT_BRIEF set, LAYOUT_FILE cleared (CMake/DoxyStyle files are missing in the submodule) and HTML_EXTRA_STYLESHEET replaced with the new res/doxygen-material.css (Material indigo palette matching the site), HTML_COLORSTYLE_HUE 220 -> 231 - CMakeLists.txt: updateGitVarsWithHash + VIEWSOLUTIONS_VERSION + configure_file_in before addDoc (same as Heart) - README.md: documentation / API reference links to https://quasarapp.github.io/ViewSolutions/
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.
Implements the same documentation site as QuasarApp/Heart#88 (QuasarApp/Heart#90):
mkdocs.ymlwith the Material theme (indigo palette for the light and slate schemes, Roboto font stack, same features/extensions as Heart).README.mdis copied todocs/index.mdat build time and served as the site home page (single source of truth, generated copy gitignored).doxygen.confis nowdoxygen.conf.in(generated file gitignored); the 15 tags Doxygen 1.18 rejects as obsolete were removed,PROJECT_NUMBERis wired to the newVIEWSOLUTIONS_VERSION(1.0..),PROJECT_BRIEFis set,LAYOUT_FILEcleared (theCMake/DoxyStylefiles referenced by it are missing in the submodule) andHTML_EXTRA_STYLESHEETreplaced with the newres/doxygen-material.css(Material indigo palette mapped onto the Doxygen 1.18 CSS custom properties, light + dark).CMakeLists.txtgetsupdateGitVarsWithHash+configure_file_inso the localdoctarget keeps working (same as Heart).README.mdgets the documentation / API reference links;.gitignorecovers the generateddocs/api/,docs/index.md,site/,doxygen.conf.Pending: the workflow file.
.github/workflows/deploy-docs.yml(theDeploy Documentation (GitHub Pages)workflow: Doxygen 1.18.0 + Graphviz installed in the workflow via marketplace actions —ssciwr/doxygen-install@v2.0.3,ts-graphviz/setup-graphviz@v2.0.2, no system apt; Doxygen output intodocs/api/;mkdocs==1.6.1+mkdocs-material==9.7.7strict build; deploy to thegh-pagesbranch viaJamesIves/github-pages-deploy-action@v4) is not in this PR yet: the QuasarAppCI token lacks theworkflowscope, so git push refuses the file and the Contents/Git-data APIs return 404 for.github/workflows/(all three paths tested, regular files work fine). The complete file content is posted on issue #16 — it needs theworkflowscope on the token (or a manual commit) before it can be added. Once the file lands on the branch, the site deploys on merge.Validated locally with the same toolchain as the runner (doxygen 1.18.0 + graphviz 2.43, mkdocs 1.6.1 + material 9.7.7): doxygen exit 0 with 0 obsolete-tag/warning lines, 703 files in
docs/api(client-sidesearchdata.js, material stylesheet linked, version 1.0.94.993e27c),mkdocs build --strictexit 0, local HTTP smoke test:/,/api/,/api/doxygen-material.css,/api/index.html,/assets/all 200.After the merge: the workflow creates
gh-pagesand the Pages source has to be set to branchgh-pages(path/) — will be done right after the first green deploy, then a live smoke test of https://quasarapp.github.io/ViewSolutions/ .