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

Build documentation and host via gh-pages #16

Closed
randomPoison opened this issue Apr 27, 2020 · 0 comments · Fixed by #17
Closed

Build documentation and host via gh-pages #16

randomPoison opened this issue Apr 27, 2020 · 0 comments · Fixed by #17
Labels
enhancement New feature or request

Comments

@randomPoison
Copy link
Contributor

Currently the only way to learn the full API for the package is to read through the source code. Ideally, we should be able to generate an online reference for the API and host it publicly via GitHub Pages. As far as I can tell tell there's no "official" documentation generation tool for .NET, so the best options I've found so far are:

  • DocFX, which seems to be a relatively new tool for the .NET ecosystem. It's developed publicly as part of the dotnet org on GitHub, so it should probably be the first thing we try.
  • Doxygen, old reliable. It's not pretty, it's not especially nice to use, but if we can't get DocFX to work with Unity for whatever reason we'll almost certainly be able to fall back to using Doxygen.

There's already an action for DocFX and one for Doxygen, plus one for updating GitHub Pages sites, so between all of the available tools we should be able to set something up.

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

Successfully merging a pull request may close this issue.

1 participant