I generated two websites that contain API references for documentation of the SharpNEAT C# API #76
CopilotCoding
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
https://copilotcoding.github.io/index.html I generated this using docfx and Natural Docs
I hope this is helpful in ideas of what is possible for generating documentation automatically, there are also many other tools which do the exact same thing so perhaps those will be better as I found docfx tedious and frustratingly error prone for using some features in it.
Natural Docs on the other hand was extremely easy to generate a website for docs.
Run this command to generate default configs:
NaturalDocs.exe ndConfigFolder
Add a line within ndFolder/Project.txt:
Title: SharpNEAT C# API Reference
Add another line:
Source Folder: sharpneatFolder
Add another line:
HTML Output Folder: ndOutputFolder
Finally, run the first command NaturalDocs.exe ndConfigFolder again, you can do this as many times as you like to regenerate the output website if you change the source files of SharpNEAT.
Beta Was this translation helpful? Give feedback.
All reactions