auto generated docs

auto generated docs

Here are a few ways to auto generate docs, starting from lower level and progressing to higher level tools: from languages and tools and then to whole sites. It's by no means exhaustive, but might be a handy starting point.

source code documentation:
jsdoc - JavaScript: http://usejsdoc.org/

C#:
Atomineer - https://www.atomineerutils.com/
DocFX - https://dotnet.github.io/docfx/
Doxygen - http://www.doxygen.nl/
GhostDoc - C#/JavaScript/Visual Basic/C++: https://submain.com/products/ghostdoc.aspx
Sandcastle Help File Builder (SHFB) - https://github.com/EWSoftware/SHFB
Wyam - https://wyam.io/

typedoc - TypeScript - https://github.com/TypeStrong/typedoc
tsdoc (a doc standard for TypeScript) - https://github.com/Microsoft/tsdoc

languages, tools:
LaTeX: https://www.latex-project.org/about/
Sphynx: http://www.sphinx-doc.org

diagram generation:
graphviz (dot) - https://www.graphviz.org/

CV (resume) generation:
CV from JSON:
jsonresume - https://jsonresume.org/

CV from markdown:
https://github.com/elipapa/markdown-cv
https://github.com/tompollard/markdown-cv

pandoc-resume - https://mszep.github.io/pandoc_resume/

note: for generating PDFs, a common practice is to instead generate HTML and then print to PDF from Chrome

sites:
Kava Docs: https://kavadocs.com
Read the Docs: https://readthedocs.org
CV generation site: https://represent.io/

Comments