[備忘] 安裝 Leo 編輯器@Windows OS~

目的:安裝 Leo 編輯器,而得以視覺化方式編輯 restructure text (*.rst)文檔。

說明:關於 Leo 的簡介。

Leo is an outlining-oriented project manager and browser. With Leo you can organize programs, web sites, URL's, pictures or any other kind of data. Leo is fully scriptable in Python. Leo is 100% pure Python. It requires the Qt gui toolkit.

前置安裝:

安裝 Leo:可參考官方安裝文件,並下載最後釋出版本

**2013/06/17 **
另一輕量級的文字編輯器:ReText。它適用於 MarkDownreStructuredText 的跨平台編輯器。使用 Python 開發,UI 界面使用 PyQT。它對 MarkDown和 MarkDown 擴展都支持得非常好,而且可以導出 PDF、HTML 和 ODT 等格式文件。

※ 安裝前先查看內附的 README 說明,包括 python, python-qt4, python-markups 等套件需先安裝。
 o How to install ReText on Windows

reStructuredText_NPP-reStructuredText basic syntax higlighting for Notepad++

※ 參考資訊
 o Leo and ReStructuredText。
 o Python Leo editor。
 o 用Python做科學計算-關於本書的編寫。
 o 用Sphinx寫書。

[摘要] 安裝與設定 Sphinx@windows 作業環境

※ 在 Windows-based 的作業系統要能具 Sphinx 的文檔寫作機制,務必要先安裝好 Python 的編譯環境。而且要對應 Sphinx 所對應的版本,例如 Sphinx 1.2b1 對應的是 Python 2.5 以上,那就不要安裝 3.x 或 低於 2.5 以下的版本,很可能 Sphinx 在編譯文檔時就會發生問題。

**2013/06/15 **
Sphinx 可以安裝在 Python 3.3.2 的環境下。先至 Python Package page for distribute 下載最新版 distribute 套件,解壓縮後至該目錄執行:

 C:>python distribute_setup.py

就可以利用 easy_install 安裝 sphinx 套件。

安裝 Sphinx @Windows 環境

參考官方安裝-Windows: Install Python and Sphinx;另一份-在 Windows 7 環境安裝 Python 2.6.6

  1. 安裝 Python : http://python.org/download/ (注意與 sphinx 搭配的 python 版本)
  2. 增加兩個 PATH 環境變數 (控制台 → 系統): C:\Python27;C:\Python27\Scripts
  3. 命列列模式下,安裝 setup tools (如此安裝 3rd party 套件會更容易):
    C:>python distribute_setup.py

    ※ 如無法自動下載 distribute 套件,則至 https://pypi.python.org/pypi/Sphinx 下載該檔並解壓縮後,至該目錄執行上述安裝指令。

  4. 利用 easy_install 安裝 Sphinx (在命令列模式下執行 easy_install.exe)。
    C:>easy_install -U sphinx

快速建立 Sphinx 預設文檔結構 (可視為每一份文檔的基礎框架)

官方主要參考文件:First Steps with Sphinx。

閱讀全文 »

關於線上文檔製作工具與管理相關機制摘記

目的:可便於在線上製作與編輯主控性文件 (具有大綱架構 (章、節)的 TOC (Table of Contents)文檔)。除了提供 HTML 格式的瀏覽,也可以轉換格式為 PDF, ePub/Mobi 等適於實體印刷與電子書格式。整理後的文檔可以容易上傳至 Hosting Server (網站/雲端空間),甚能具有版本控管與協同編輯撰寫的功能。

說明:原來為編寫 Python 線上文件而所開發以 Python 語言編寫的工具-Sphinx,已逐漸成為製作線上文件的最普及好用的免費開源工具。關於 Sphnix 的幾個主要特性:

  • 輸出格式:HTML (including Windows HTML Help), LaTeX (for printable PDF versions), Texinfo, manual pages, plain text。
  • 廣泛的交互參考 (cross-references):語義化的標記 (semantic markup),並對包括 函式、類別、引用文、術語詞彙表與類似片段資訊提供自動化的鏈接 (automatic links)。
  • 階層式的結構: 可輕鬆定義樹狀文件,並自動化鏈接同級/父級/下級 (siblings, parents and children)的文件。
  • 自動化的目錄: 產出與特定語言關聯的模組索引目錄。
  • 程式碼的處理:利用 Pygments highlighter 自動生成各程式語言的高亮度代碼區塊。
  • 擴展套件: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs) ...。

先瞧瞧一位大陸知名 IT 作者利用 Sphinx 所整理出很棒的線上文檔-GotGitHub,就可以看出 Sphinx 的強大功能。

另外一個參考展示-編寫《Redis 設計與實現》時用到的工具

閱讀全文 »

軟體思維顧問

專職軟體輔導與教育訓練的獨立顧問。輔導企業資訊單位如何有效組織系統開發與維護;輔導開發人員達成有效的專業分工。傳授如何把軟體作軟 (Keeping Software Soft)的技能,得以提昇系統的彈性/延展,並進而創造系統的再利用價值。

Personal