开源一体化文档编写工具sgml/sphinx/markdown各自的适用场景

  一体化文档编写工具主要有sgml(pg采用)和sphinx(python社区和read the docs采用)两大类,官方文档推荐、索引全面,跟HTML高度雷同,当然也有一些采用markdown(github wiki或非正式文档推荐)。在lightdb中,三种文档均有采用。github上的文档采用markdown或手写为主,不够非常正式,用户手册以word或sgml/sphinx生成pdf和在线html为主。

markdown文档:https://blog.csdn.net/SL_World/article/details/99291733  markdown表格语法,推荐IDE Haroopad - The next document processor。

sphinx相关参考资料:

https://zhuanlan.zhihu.com/p/563055999

https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html

https://zhuanlan.zhihu.com/p/264647009

https://zhuanlan.zhihu.com/p/510666093

https://www.zhihu.com/topic/20848782/newest

sgml:参考pg官方文档拷贝改即可。

posted @ 2022-12-04 13:25  zhjh256  阅读(98)  评论(0编辑  收藏  举报