-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Add Docfx Code Doc generation support #2092
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this PR should be draft until we know how to integrate it with the documentation repository. Right now, there's almost no team-wide knowledge, afaik, on how to maintain/use/host docfx or if this is even a useful step towards the overall "documentation" goal.
Questions we need to answer are:
- Do we need another tool for docs? Why docfx? What does it do that docusaurus can't?
- Can we export docfx for our docusaurus docs.
- Instructions on how to export/how to keep the documentations in sync with our code.
- Are we gonna use github actions to do it automatically to improve maintainability?
DocFx can generate code docs from C# XML comments as opposed to Docusaurus which as far as I can tell from the limited browsing of its site, only appears to support manually written documentation
Yes we can, Here is a tool that does exactly that
DocFx does not currently run automatically when the project is built, the documentation for docfx itself lies here
We don't strictly have to use github Actions as unfortunately it does require compiling Nitrox itself which in turn requires Subnautica. |
This adds docFx code doc generation support, adds a new "Linux Release" configuration which does not build the NitroxLauncher project, and clears out some excessive error spam caused by NitroxAnalyzer not running.