Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unity package layout is incompatible #20

Open
CaseyHofland opened this issue May 24, 2021 · 3 comments
Open

Unity package layout is incompatible #20

CaseyHofland opened this issue May 24, 2021 · 3 comments

Comments

@CaseyHofland
Copy link

CaseyHofland commented May 24, 2021

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.

UIWitches.

@CaseyHofland CaseyHofland changed the title Is this Unity package compatible? Not Unity package compatible May 24, 2021
@CaseyHofland CaseyHofland changed the title Not Unity package compatible Unity package compatibility May 24, 2021
@CaseyHofland
Copy link
Author

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?

@CaseyHofland CaseyHofland changed the title Unity package compatibility Unity package layout is incompatible May 24, 2021
@thehen
Copy link

thehen commented Oct 23, 2022

I'm also interested in this

@bohyunjung
Copy link

bohyunjung commented 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants