使用sphinx建立和檢視文件

2022-03-29 01:19:39 字數 427 閱讀 2008

1. 安裝pip

$ sudo apt-get install python-pip

2. 安裝全文本瀏覽器lynx

$ sudo apt-get install lynx

3. 使用pip安裝sphinx

$ pip install sphinx

4. sphinx-quickstart可以快速新建乙個新的文件記錄

$ sphinx-quickstart

$ sphinx-build -b html . output

此時生成的html結果全部位於新建立的output目錄,首頁是index.html。

$ lynx index.html

就行了。

使用sphinx自動建立API文件(一)

建立test demo為根目錄,下面分別建立doc和src資料夾。doc 之後用來儲存生成的 html 檔案和相關配置 src 源 python 檔案 src下面的 demo 檔案分別有如下內容 demo1 class demo1 english demo1.defdemo1 self,arg1 s...

sphinx使用整理文件

相關命令及步驟 建立主索引 usr local coreseek bin indexer c usr local coreseek etc csft mysql.conf all 檢視狀態 ps ef grep searchd 建立增量索引 1.建立測試資料表以及資料 2.修改配置檔案 主索引源 s...

使用Sphinx編寫文件

作業系統 windows7 x64 python 版本 2.7.10 sphinx 版本 使用pip安裝 pip install u sphinx pip install sphinx rtd theme 從原始碼安裝 在控制台輸入以下命令 sphinx quickstart 根據實際情況填寫。in...