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

Publish human-readable docs #1

Open
thekaveman opened this issue Sep 15, 2014 · 2 comments
Open

Publish human-readable docs #1

thekaveman opened this issue Sep 15, 2014 · 2 comments
Labels
docs Documentation
Milestone

Comments

@thekaveman
Copy link
Contributor

Visual Studio is generating XML documentation from the source code. This should be turned into something a person can navigate and understand easily.

@thekaveman thekaveman added the docs Documentation label Sep 15, 2014
@thekaveman thekaveman added this to the v0.2 release milestone Sep 17, 2014
@thekaveman
Copy link
Contributor Author

Some ideas for publishing include

  • GitHub wiki on this repository
  • GitHub pages site

@thekaveman thekaveman modified the milestones: v1.0 release, v0.2 release Oct 9, 2014
@allejo
Copy link
Collaborator

allejo commented Apr 11, 2016

sharpDox - Example

  • Lightweight
  • Looks flat and clean
  • Only supports CHM and HTML

SHFB - Example

  • Robust
  • MSDN style
  • Supports exporting in multiple formats out of the box (chm, html, md, docx, mshc)

Doxygen - Example

  • Incredibly robust and thorough; there's a lot you can/should configure
  • Classifies and organizes things in several different manners
  • Several output formats

All

  • are extensible through plug-ins
  • command line utilities (can be used to automate generation)
  • free and open source

There are other options but they're either not straightforward or they haven't been too active recently:

  • Docu
  • Nocco
  • Natural Docs

@thekaveman thekaveman modified the milestones: vNext, v1.0 release Jun 2, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

No branches or pull requests

2 participants