使用Sphinx編寫文件

2022-02-10 02:21:36 字數 972 閱讀 8982

作業系統 : windows7_x64

python 版本 : 2.7.10

sphinx 版本 :

****:

使用pip安裝:

pip install -u sphinx

pip

install sphinx_rtd_theme

從原始碼安裝:

在控制台輸入以下命令:

sphinx-quickstart

根據實際情況填寫。

index.rst示例**:

.. _tutorial-index:

.. highlight:: python

:linenothreshold:

0sphinx示例文件

**********===:release: |version|:date: |today|歡迎閱讀sphinx示例文件

*********************************************內容示例:

.. toctree::

:maxdepth:

2test1.rst

index.rst 為主檔案

test1.rst 為具體內容

test1.rst示例內容:

rst語法簡介

**********=空行分段

----------第一段內容。

第二段和第一段間有空行。

生成html文件

sphinx-build -b html source/ build/

使用sphinx編寫文件.rst

歡迎補充

編寫 Sphinx 文件

編寫 sphinx 文件 參考 官網 文件轉換神器 restructuredtext 語法簡介 用 restructuredtext 寫作 快速入門指南 restructuredtext markup specification sphinx 教程 sphinx 使用手冊 使用 sphinx 快速為...

sphinx使用整理文件

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

sphinx配置文件

sphinx的配置 source 源名稱1 index 索引名稱1 source 源名稱2 index 索引名稱2 indexer searchd type 資料庫型別 mysql 或sql sql user 資料庫使用者名稱 sql pass 資料庫密碼 sql db 資料庫名稱 sql port...