TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: How do you generate documentation?

4 pointsby adam_ellsworthalmost 5 years ago
It seems there&#x27;s a new Open Source documentation generator project out there pretty regularly and I&#x27;m sure a litany of paid services to manage better docs. In the past we&#x27;ve used lots of different tools from jsdoc parsers to stoplight; however we&#x27;re in the need for a new solution that can work well for a very small team.<p>Primarily looking for:<p>- API Docs - SDK Docs - Code structure docs (beyond tests and codecoverage)

3 comments

ddavisalmost 5 years ago
Sphinx is very nice to work with, and it&#x27;s been around for a long time. I&#x27;ve used it for Python projects, C++ projects (with doxygen and breathe), and some programming language agnostic things. It&#x27;s almost trivial to pair Sphinx docs with readthedocs.org as well. For smaller pieces of documentation (and many personal things) I use Org mode in Emacs. Org mode supports exporting to a wide variety of formats.
评论 #24118229 未加载
simonblackalmost 5 years ago
After sweating drops of blood through my forehead and recording the results with Libre Office, I then export it to PDF.<p>I&#x27;ve tried super-duper generators in the past. They never seem to give you results that are worth the effort and time spent.
edoceoalmost 5 years ago
I&#x27;m using OpenAPI, Doxygen and Asciidoctor. We also have Phabrixator for internal wiki and project tools