Incorporate API reference generation into build/deploy workflow

Fexty12573 / SharpPluginLoader

A C# plugin loader for Monster Hunter World

MIT License

32 stars 2 forks source link

Incorporate API reference generation into build/deploy workflow #7

Closed Fexty12573 closed 3 months ago

Fexty12573 commented 8 months ago

Summary

The API documentation needs to be auto-generated either when building or when pushing to the repo. The current files are generated using a modified version of xmldoc2md (to support .NET 8 and fix some compatibility issues).

Status

Not started at all

What needs to be done

[ ] Incorporate the md file generation into the build process
[ ] Copy files into appropriate docs directory
[ ] Adjust mkdocs.yml nav based on the output

Fexty12573 commented 3 months ago

Implemented with migration to docfx