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

Improve Unity C# Documentation #534

Merged
merged 4 commits into from
Dec 20, 2024
Merged

Improve Unity C# Documentation #534

merged 4 commits into from
Dec 20, 2024

Conversation

azrogers
Copy link
Contributor

@azrogers azrogers commented Dec 9, 2024

In line with CesiumGS/cesium-unreal#1566 and the improvements to Cesium Native's documentation, this PR does the same for Cesium for Unity.

  • Doxygen Awesome CSS theme added, as done in Unreal and Native. Needed to be a submodule here as NPM will choke when trying to install dependencies from the Unity package.json.
  • Organized existing documentation pages, including the Reinterop README, into something resembling a page hierarchy.
  • Fixed the warnings reported by Doxygen (not many!)
  • Changed CI to use the latest version of Doxygen, as done in Unreal and Native.

Probably the biggest thing to note is that the Documentation~ folder had to be renamed to Documentation, as Doxygen seems to interpret an image at Documentation~/images/image_name.jpg as an image at Documentation with the caption ~/images/image_name.jpg.

@kring
Copy link
Member

kring commented Dec 13, 2024

Probably the biggest thing to note is that the Documentation~ folder had to be renamed to Documentation

That's probably going to cause problems, because Unity is going to pick up the folder as assets now. There are some other options for hiding assets, but none of them are great:
https://docs.unity3d.com/Manual/SpecialFolders.html

Any ideas?

@azrogers
Copy link
Contributor Author

My first idea was to report the tilde issue on the Doxygen GitHub repo but that's hardly an immediate fix. I can try out some other workarounds.

@azrogers
Copy link
Contributor Author

@kring Added the workaround we talked about, renaming Documentation back to Documentation~ and copying the images over when building the docs (using a Node script to get around cross-platform issues with cp vs copy).

@kring
Copy link
Member

kring commented Dec 20, 2024

Thanks @azrogers!

@kring kring merged commit 2a1ccb9 into main Dec 20, 2024
7 checks passed
@kring kring deleted the cesium-unity-docs branch December 20, 2024 12:18
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

Successfully merging this pull request may close these issues.

2 participants