使用sphinx記筆記

2021-08-30 14:09:27 字數 1339 閱讀 1680

簡單來說,這是乙個基於restructuredtext的文件生成工具。方便易用,功能強大。

有很多開源工程都採用sphinx作為文件生成系統,最有名的就是 python官方文件 。 在 sphinx官方 ** 上也列出使用sphinx的專案,有將近90個左右,其中不乏大名鼎鼎的開源專案。

一些中文的翻譯專案也採用了sphinx,如 pymotwcn 。

1. 安裝python

2. 要確認已經安裝了setuptools

3. 在命令列輸入easy_install sphinx

建議使用sphinx自帶的配置工具sphinx-quickstart。 - 建立乙個工程目錄,比如d\:note。 - 在該目錄啟動命令列,輸入sphinx-quickstart

d:\note>sphinx-quickstart

基本完成了,使用make html命令就可以生成html形式的文件了。

conf.py檔案包含了sphinx工程的所有配置選項,包括一些無法在sphinx-quickstart中進行設定的。

分為三部分:

下面是一些常用的選項:

restructuredtext會根據下劃線讀取文件的標題,並且可以自動組織索引

********************=

文件標題

********************=

--------

子標題--------

章節標題

*****===

...

列表中,相同的層級使用相同的縮排。

列表中同一層級不需要空行分隔。不同層級起始處必須有空行。

列表:-條目

-條目-條目

-條目-條目

例如 http:

命名鏈結,為鏈結命名,有助記憶和減少空間占用。

在正文中使用 《鏈結名》_ ,注釋中使用 _《鏈結名》: [鏈結目標]

例如 ubuntu

sphinx對嵌入程式**的支援很好(本來就是為了編寫python文件而開發的工具)。

在段落的結尾新增符號 :: ,則表明下面的段落為**段落。**段落相對之前的段落要縮排一次。

只要沒有空行,不管換多少次行,都會處理為一行。 建議您將每行的內容控制在50個漢字或者100個字母之內, 盡量在標點符號處手動換行,以增加原始檔的可讀性。

暫時沒有發現支援restructuredtext的blog,不知道大家有沒有知道的。如果能直接用restructuredtext寫blog 就太好了。

a restructuredtext primer

使用 Markdown 記筆記

slogan markdown 讓你愛上寫作 markdown 是一種輕量級的 標記語言 通常為程式設計師群體所用,目前它已是全球最大的技術分享 github和技術問答 stackoverflow的御用書寫格式 標題是每篇文章必備而且最常用的格式,在 markdown 中,如果想將一段文字定義為標題...

記筆記記筆記 RMQ ST演算法

1.概述 rmq range minimum maximum query 即區間最值查詢,是指這樣乙個問題 對於長度為n的數列a,回答若干詢問rmq a,i,j i,j n 返回數列a中下標在i,j之間的最小 大值。這兩個問題是在實際應用中經常遇到的問題,下面介紹一下解決這兩種問題的比較高效的演算法...

sphinx使用學習筆記

1.2.安裝完成後,在python的scripts目錄下,可以看到乙個叫做easy install sphinx的可執行檔案或是easy install 3.4,在命令列裡執行它 執行過程時間較長,可能出現easy install sphnix the read operation timed ou...