TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Ask HN: How do you generate documentation?

4 点作者 adam_ellsworth将近 5 年前
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 条评论

ddavis将近 5 年前
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 未加载
simonblack将近 5 年前
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.
edoceo将近 5 年前
I&#x27;m using OpenAPI, Doxygen and Asciidoctor. We also have Phabrixator for internal wiki and project tools