//owent.net/tags/sphinx.htmlRecent content in Sphinx on I'm OWenTHugozh-cn<a rel="license" href="https://github.com/owent/blog-hugo/blob/master/LICENSE.md"><img alt="知识共享许可协议" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png" /></a>Tue, 03 Apr 2018 17:22:42 +0000//owent.net/2018/1803.htmlTue, 03 Apr 2018 17:22:42 +0000//owent.net/2018/1803.html<p>离上一次写Blog过了好久啦。这次拖这么长时间主要是因为最近学习了一个新的文本标记语言 &ndash; <a href="https://en.wikipedia.org/wiki/ReStructuredText">ReStructuredText</a> 。并且重新整理了<a href="https://github.com/xresloader/">Excel导表工具-xresloader工具集</a>的文档，写文档真是好废好废时间啊。</p> <p>好多项目用<a href="https://en.wikipedia.org/wiki/ReStructuredText">ReStructuredText</a>来写文档来着，比如<a href="https://cmake.org/">cmake</a>，再比如<a href="https://www.python.org/">python</a>。然后现在有比较容易上手的<a href="https://readthedocs.com/">readthedocs</a>来托管文档，和<a href="https://github.com/">github</a>的集成也还不错。所以我打算把一些项目的文档也迁移上去。毕竟 <strong>README.md</strong> 还是弱了些。</p> <p>其实<a href="https://en.wikipedia.org/wiki/ReStructuredText">ReStructuredText</a>也支持 <strong>Markdown</strong> 。但是使用 <strong>Markdown</strong> 写文档还是略麻烦，特别是涉及跨文档引用和多行表格的时候，而且 <strong>Markdown</strong> 各个平台的组件和扩展还都不一样，没有统一标准。在这些方面<a href="https://en.wikipedia.org/wiki/ReStructuredText">ReStructuredText</a>就强大多了。不过这也是有代价的，那就是<a href="https://en.wikipedia.org/wiki/ReStructuredText">ReStructuredText</a>的语法规则比 <strong>Markdown</strong> 复杂得多。</p>