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

Publish Doxygen documentation online on release #832

Open
azrogers opened this issue Mar 18, 2024 · 6 comments
Open

Publish Doxygen documentation online on release #832

azrogers opened this issue Mar 18, 2024 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@azrogers
Copy link
Contributor

azrogers commented Mar 18, 2024

Similarly to CesiumGS/cesium-unreal#1377, we currently don't publish the Doxygen docs that we build for cesium-native. For the reasons listed in the linked issue, it would be a good move for us to publish the cesium-native docs online as well.

@azrogers
Copy link
Contributor Author

CC @AndieTursi

@azrogers
Copy link
Contributor Author

Summarizing here all the requests for API documentation that I could find.

First, on GitHub:

  1. Find best method for organizing developer documentation #619 - "may I ask why I can't find a developer manual about Cesium Native?"
  2. Create C++ API reference cesium-unreal#689 - "Cesium JS and the ion SDK have a documentation page like this available from the Learn menu. Can we create something like this for the C++ codebase for Cesium-Unreal?"

A few posts on the forum about Unreal documentation:

  1. Can you make a documentation like UE4 documentation
  2. Where can I find the c++ documentation without having to build it myself?

And many more about Unity documentation:

  1. Where can I find the API documentation for the Cesium for Unity package?
  2. Is there any relevant API documentation, such as which interfaces to call when I want to perform coordinate conversion
  3. Where can I find the documentation of Cesium components and their methods to program from C# scripts?
  4. Cesium for Unity documentation somewhere?
  5. Is there an api for unity
  6. Also where can i get unity c# documentation for cesium
  7. I also can’t find the API documentation for the CesiumUnity package so I have to read the source code to figure it out
  8. is there any link for Scripting API to help me learn the function of each script

Unity would take a bit more effort since we're not currently generating any documentation for the C# side of things. This would just require setting up Doxygen or DocFX as part of the build process. For Unreal and Native, we mostly just need to adapt the JSDoc template from CesiumJS to work for Doxygen - or grab an existing template and slap our logo on it.

@shehzan10

@azrogers
Copy link
Contributor Author

Couldn't leave it for over the holiday - added Unity Doxygen support in CesiumGS/cesium-unity#471.

@corybarr
Copy link
Contributor

Several times in the past, I would have found online documentation useful.

@j9liu j9liu added the documentation Improvements or additions to documentation label Oct 28, 2024
@j9liu
Copy link
Contributor

j9liu commented Nov 8, 2024

Progress: we published our docs as-is to https://cesium.com/learn/cesium-native/ref-doc/, and plan to keep updating them in the future.

TODO: We probably need to automate publishing the docs on release. CesiumJS publishes their docs through CI as part of their own release process -- is there any way we can do the same?

Once the above is taken care of, this issue can be closed.

@kring
Copy link
Member

kring commented Nov 8, 2024

We probably need to automate publishing the docs on release. CesiumJS publishes their docs through CI as part of their own release process -- is there any way we can do the same?

Docs are automatically published by CI whenever we merge into the cesium.com branch of cesium-native. We just need to be sure to do that as part of our release process.

It's slightly different from the CesiumJS process in that our CI generates and publishes docs for whatever you push to the cesium.com branch. The CesiumJS process downloads the last published CesiumJS release from https://github.com/CesiumGS/cesium/releases/latest and publishes that.

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

No branches or pull requests

4 participants