文档工具-sphinx
文章平均质量分 64
sphinx
无为开发者
为学日益,为道日损。损之又损,以至于无为。
展开
-
打造个人笔记—03Sphinx案例之markdown笔记
上篇文章简单介绍了rst笔记的写法,本文将介绍使用markdown来记笔记,如何用sphinx来生成好看的静态网页。原创 2024-04-13 07:00:00 · 439 阅读 · 0 评论 -
打造个人笔记—02Sphinx案例rst语法
接下来我将使用sphinx整理一个笔记,进一步熟悉sphinx,笔记的内容就选择整理一下rst的语法吧,毕竟markdown语法比较简单,并不太需要什么笔记。rst是sphinx默认支持的语法,语法比较复杂,需要经常翻阅多次才能熟练使用。笔记最终效果如下:,这个也是我比较喜欢的一个主题,还有其它类似pyData也很好看。左侧是不同的文档(或者一级标题),右侧是单个文档的目录,方便定位查看,搜索功能也不错,虽然不能预览全文,但搜索功能是全文搜索的,不止是标题。。原创 2024-04-11 19:00:00 · 358 阅读 · 1 评论 -
打造个人笔记—01Sphinx快速上手
Sphinx 是一个基于 Python 的文档生成项目。最早只是用来生成 Python 的项目文档,使用 reStructuredText 格式(简称rst)。但随着 Sphinx 项目的逐渐完善,目前已发展成为一个大众可用的框架,很多非 Python 的项目也采用 Sphinx 作为文档写作工具,甚至完全可以用 Sphinx 来写书。非常适合打造个人笔记系统。原创 2024-04-09 22:30:54 · 330 阅读 · 0 评论