DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> HTML基礎知識 >> HTML5詳解
在 Linux 上安裝 Sphinx(Python 文件工具)完整流程
編輯:HTML5詳解     

搜尋 Sphinx 時很容易撞到另一個同名老牌全文檢索引擎,但這裡要談的是文件工具:由 Georg Brandl 在 BSD 授權下開發,用 reStructuredText 寫作、輸出成網站或 PDF 的那一套。

一、Sphinx 是什麼

它最早是為了改寫 Python 官方文件而生,如今已是 Python 專案的標準文件方案,對 C/C++ 專案也有良好支援。Python 官方文件本身就是它最有說服力的樣品。主要特色包括:

  • 多元輸出格式——HTML(含 Windows 說明檔)、LaTeX(轉 PDF)、man page、純文字。
  • 完整的交叉引用——語意化的標記,可對函式、類別、引文、術語等自動建立連結。
  • 清晰的層級結構——輕鬆定義文件樹,並自動產生同層、上下層的導覽連結。
  • 自動索引——模組索引不必手寫,自動生成。
  • 精準的語法高亮——以 Pygments 為基礎,支援語言相當廣泛。
  • 開放擴充——支援 code block 自動測試、自動擷取 Python docstring 等。
  • 由於以 reStructuredText 作為標記語言,還能直接享受 Docutils 生態系的各式工具。

二、安裝步驟

以下以 Debian 5 為示範環境,其他發行版概念相同。

1)安裝 Python

下載與安裝:https://www.python.org/download/
多數 Linux 發行版已預裝 Python,可用 python --version 確認版本。

2)安裝 setuptools

它是安裝 easy_install 的前提,而 easy_install 是我們下一步要用的套件管理器。

Windows:直接下載對應 Python 版本的 exe 安裝檔,執行即可。例如 Python 2.7 對應:
https://pypi.python.org/packages/2.7/s/setuptools/setuptools-0.6c11.win32-py2.7.exe

Mac OS X / Linux:先下載對應版本的 egg 檔(我的環境是 Python 2.6.6):

wget https://pypi.python.org/packages/2.6/s/setuptools/setuptools-0.6c11-py2.6.egg

然後執行安裝:

sh setuptools-0.6c11-py2.6.egg

完成後 easy_install 指令就可以用了。

補充一點:在較新的系統上,setuptools 已逐步被 pip 取代,多數發行版可以直接用套件管理器安裝(Debian/Ubuntu 為 apt-get install python-pip),會省下不少功夫。

3)安裝 Sphinx

easy_install -U Sphinx

若使用 pip,則為:

pip install -U Sphinx

安裝完成後,執行 sphinx-quickstart 就能開始建立第一份文件專案了。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved