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

Added SHFB automated doc generation project #490

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ritchiecarroll
Copy link

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 docs folder 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.

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

Successfully merging this pull request may close these issues.

1 participant