Repository navigation
Unity package layout is incompatible #20
Description
EDIT: This is my old comment but after some testing I have already found the answer. For the real issue, read my next comment.
Right now it's more of a question than an issue, depending on the answer this might be an issue.
I am writing a Unity package and was hoping to generate documentation for it, however I understood from this issue that the .csproj file is needed for this to work (but I might be misreading it). Unity packages work with .asmdef files, but not .csproj files. Can it still be done?
If it IS compatible, then it might just be something in my configuration, but if it is I can't find out what.
All I have modified so far is:
- .github/workflows/documentation.yml to use "Documentation~" directory instead of "Documentation" directory.
- Documentation~/filterConfig.yml for my main namespace.
- Documentation~/docfx.json src, globalMetaData and sitemap.
Activity
[-]Is this Unity package compatible?[/-][+]Not Unity package compatible[/+][-]Not Unity package compatible[/-][+]Unity package compatibility[/+]CaseyHofland commentedon May 24, 2021
DocFX works great for me if my github is structured like a Unity project. However, I want to generate documentation for Unity packages, whose (preferred) layout can be found here.
Notably, this layout does not contain a .csproj or .sln file, only .asmdef files.
Ideally, I would like a solution. Regardless, I am interested in why DocFX doesn't work for Unity packages. Are the .csproj files the culprit, and if so can documentation be generated without them?
[-]Unity package compatibility[/-][+]Unity package layout is incompatible[/+]thehen commentedon Oct 23, 2022
I'm also interested in this
bohyunjung commentedon Feb 20, 2024
For anyone who has gotten here, @CaseyHofland has made a GitHub action for the docfx documentation for Unity
packages,and the workflow worked for me. Kudos to @CaseyHofland! 🙌https://github.com/CaseyHofland/docfx-unitypackage
docs(readme): compatibility table, current DocFX links, package layout
docs(readme): document the Unity package layout (#20)
NormandErwan commentedon Oct 18, 2026
#44 adds a "Unity package layout" section to the README:
Documentation~/at the package root, with the sources and namespace pages pointed atRuntime/. Tested with DocFX 2.81.0.Generated by Claude Code
docs(readme): document the Unity package layout (#20)
docs(readme): document the Unity package layout (#20)