docs: Set up Doxygen + Doxygen Awesome for SDK reference documentation#450
Closed
kirre-bylund wants to merge 2 commits into
Closed
docs: Set up Doxygen + Doxygen Awesome for SDK reference documentation#450kirre-bylund wants to merge 2 commits into
kirre-bylund wants to merge 2 commits into
Conversation
- Add .doxygen/ with Doxyfile, Doxygen Awesome theme, custom CSS, nav JS,
layout, header/footer, and LootLocker branding
- Add .github/workflows/generate-docs.yml: validates on PR, uploads artifact
on push to main, attaches docs-{version}.zip to releases
- Add .gitattributes: export-ignore for .doxygen/, .github/, Tests/ etc.
- Update .gitignore: exclude docs/html/ generated output
- Add @InGroup and XML doc annotations to source files for featured coverage
Closes lootlocker/index#1461
Part of lootlocker/index#1203
7f8e41e to
bb1a529
Compare
2d853a7 to
33a850d
Compare
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
Sets up Doxygen with the Doxygen Awesome CSS theme as the documentation generator for the Unity SDK, and adds a CI workflow that packages and publishes the generated docs.
Closes lootlocker/index#1461
Part of lootlocker/index#1203
Changes
.doxygen/— all generation config (export-ignored, not shipped with SDK)Doxyfile— input:Runtime/, excludes Libraries/Editor/internal files, output:docs/html/;EXTRACT_ALL=NO/HIDE_UNDOC_MEMBERS=YES;INTERNAL_DOCS=NO;JAVADOC_AUTOBRIEF=YESdoxygen-awesome/—doxygen-awesome.css+doxygen-awesome-sidebar-only.cssfrom jothepro/doxygen-awesome-csscustom-layout-fixes.css— 500px sidebar, branding padding, sidebar background extensionlootlocker-theme.css— LootLocker colour overridesnav-customization.js— two-phase nav tree restructuring: enums into Types, Topics hoisted to root, namespace prefixes stripped from sidebar labelsDoxygenLayout.xml— Types before Topics; pages/modules/namespaces hiddenheader.html/footer.html— custom HTML with script injection for nav-customization.jsimages/lootlocker-logo.png— branding.github/workflows/generate-docs.ymlmainordevmainsdk-docs-{sha}artifact (30-day retention)docs-{version}.zipto the GitHub release.gitattributes.doxygen/added toexport-ignore— generation config is stripped from archives and package exports; onlydocs/html/(generated output) ships with the SDK.gitignoredocs/html/excluded from version control (generated output)package.jsondocumentationUrlpoints to hosted docs — Unity Package Manager surfaces this as the "Documentation" buttonVerification
Ran locally with Doxygen 1.16.1: