在 GitHub上的 C++ 项目,应该用什么文档工具写使用手册和 API 手册?
关注者
356被浏览
21,176登录后你可以
不限量看优质回答私信答主深度交流精彩内容一键收藏
首先多謝各位提供的答案,之後考慮了這些答案以及其他網友的意見,最後得出一個方案。
分享一下我現時的方案。效果:
RapidJSON: Main Page這個方案沿於發現較新版本的 Doxygen 支持了 Markdown,可以 Markdown 作為輸入,然後生成HTML。
然後在 Travis CI 寫腳本運行 Doxygen,當每次有新 commit,就會自動生成文檔及上載至 GitHub Pages。(
.travis.yml,
travis-doxygen.sh)
更改 doxygen 的 header/footer HTML及CSS文件,讓 Markdown 的效果接近 GitHub,而 navigation 風格則是接近
Read the Docs。
現在還未細調 API reference 的 CSS,但整體效果我覺得可以了。而且在 Markdown 裡,代碼中的類、方法還可以直接鏈接至API reference。
唯一有些問題是由GitHub渲染的Markdown中鏈接會出現錯誤,但不影響閱讀。
另外,那些圖是用
Graphviz繪畫的。