开源一体化文档编写工具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 @   zhjh256  阅读(189)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 分享4款.NET开源、免费、实用的商城系统
· 全程不用写代码,我用AI程序员写了一个飞机大战
· MongoDB 8.0这个新功能碉堡了,比商业数据库还牛
· 白话解读 Dapr 1.15:你的「微服务管家」又秀新绝活了
· 上周热点回顾(2.24-3.2)
历史上的今天:
2021-12-04 JOIN表达能力远比你想的强大--postgresql/lightdb a [left/right] join b on true的含义
2021-12-04 c/c++ # and ## in macros以及宏debug
2018-12-04 ORA-12801/ORA-12853: insufficient memory for PX buffers: current 274880K, max needed 19722240K/ORA-04031解决方法
2018-12-04 关于oracle result_cache
2016-12-04 2016年12月数据库流行度排行榜
2016-12-04 excel查看VBA代码快捷键
点击右上角即可分享
微信分享提示