sphinx使用學習筆記

2021-07-23 16:53:16 字數 2218 閱讀 9319

1.

2.安裝完成後,在python的scripts目錄下,可以看到乙個叫做easy_install sphinx的可執行檔案或是easy_install-3.4,在命令列裡執行它

執行過程時間較長,可能出現easy_install sphnix the read operation timed out

這個可能是網路問題也可能是由於沒有安裝setuptools工具導致的

setuptool

setuptools-28.3.0.zip

(md5)

3.easy_install sphinx執行完成後

命令行會提示finished processing dependencies for shinx,說明配置成功。

4.此時在命令列輸入sphinx-build,看看是否會出來說明資訊

如果在安裝python時,沒有設定環境變數,可能會彈出sphinx-build不是內部或者外部命令。

需要在計算機的屬性-高階系統設定-高階中 新增系統環境變數path路徑是python目錄下的scripts。

再次執行會有相關資訊,說明完成了。

5.完成後可以使用sphinx自帶的配置工具建立sphinx工程

在d盤新建乙個工程檔案如demo

命令列進入demo 在demo下輸入sphinx-quickstart

出現歡迎資訊,大部分配置使用預設即可 ,即一直回車即可

分離source和build目錄,輸入y  方便管理,

輸入工程名、作者名、版本號等,其餘回車

完成後可以看到demo目錄下有以下檔案:make.bat  檔案makefile、資料夾source、資料夾build 

^在demo目錄命令列下輸入make html, 生成html。原始檔是rst格式 在source下,生成的html在build下

^在demo目錄命令列下輸入make latex,生成tex格式檔案在build中的latex下,將tex格式檔案用texworks軟體開啟,使用

xelatex或pdftex可以生成pdf檔案

6.rst原始檔中,文件編輯的常見符號有

文件標題

*****===

一級標題

乙個星號  *text*為重點 (斜體)

兩個星號 **text**強調 (加粗)

\ **text** \ 加粗後去掉空格 \和*之間有乙個空格

反引號 ``text`` **樣本

* 標題

要點二級標題

~~~~~~~~~~~~~~~

**標題

線塊|這個是線塊

|是保留換行符的一種方式

插入文字框註解

.. note:: 內容

導航在開頭處:

* 第 21 頁,:ref:`簡介_jj`

.. _簡介_jj:

插入**

.. list-table:: 

:widths: 15,25,20

:header-rows: 1

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

a b a and b

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

false false false

true false false

false true false

true true true

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

插入.. image:: _static/4-2/1.png

儲存在source中的_static中

目錄樹.. toctree::

:maxdepth: 2

4.1總體介紹.rst

4.2可用性.rst

4.3資料服務.rst

maxdepth表示目錄的層數,index檔案是第三層,是主目錄

這是第二層,屬於主目錄第四章的目錄

7.conf.py配置

封面latex_documents = [

修改字型格式 字型大小等

使用sphinx記筆記

簡單來說,這是乙個基於restructuredtext的文件生成工具。方便易用,功能強大。有很多開源工程都採用sphinx作為文件生成系統,最有名的就是 python官方文件 在 sphinx官方 上也列出使用sphinx的專案,有將近90個左右,其中不乏大名鼎鼎的開源專案。一些中文的翻譯專案也採用...

sphinx使用步驟

sql 結構化查詢語言 是一種標準,所有的關係型資料庫mysql,sqlserver,oracle sphinx的使用兩種方式 第一種 使用sphinx的api來操作sphinx 常用 sphinx可以使用api類,也可以將api編譯到php中做為擴充套件 第二種 使用mysql的sphinx的儲存...

sphinx安裝使用

解壓收編譯配置 configure prefix usr local sphinx with mysql make make install cd usr local sphinx etc cp sphinx.conf.dist sphinx.conf 使用sphinx自帶的例子 匯入測試資料 my...