Added SHFB automated doc generation project #490
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For your consideration:
Added a documentation generation project to create API documentation from structured XML comments.
The following Visual Studio extension is required in order to load and build docs: https://github.com/EWSoftware/SHFB/releases
Generated docs can be rendered like so (hosted on fork as an example):
https://gridprotectionalliance.github.io/bc-csharp/help/html/About.htm
This added project is currently targeting
docsfolder in root as a build location, then the forked site is using GitHub pages rendered from that folder as an example of generated docs, but this is all configurable.