.. sphinx_doc documentation master file, created by
   sphinx-quickstart on Fri Nov 23 05:35:46 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

文件編寫工具-sphinx
======================================

長期以來靠網路取得工作的知識,最近想要把腦中學過知識寫成書放在網站上面,給自已及需要的人看,於是上網找看看有沒有適合的工具使用.
於是發現 sphinx_ 這套工具,仔細的研究一下還蠻好用的,本網站的所有文件開發就是用 sphinx_ 工具所開發的.當然包含了本頁.
sphinx_ 是一套好用的工具,它有下面陳列的幾項特色:

* 輸出格式(Output formats):HTML,(for printable PDF versions), ePub, Texinfo, manual pages, plain text
* Extensive cross-references:語意標記並且可自動鏈結函數(function),類別(classes),引用(citations),術語字彙(glossary terms),similar pieces of information
* 階層結構(Hierarchical structure):簡易定義樹狀階層,自動鏈結上下文及前後文.
* 自動索引(Automatic indices):一般索引以及特定於語言的模塊索引
* 程式碼處理(Code handling):自動突出顯示,使用 Pygments_ highlighter.( _Pygments 是各種語言的語法突出顯示)
* 擴展(Extensions):自動測試代碼片段，包含Python模塊中的文檔字符串（API文檔）, 更多參考_
* 貢獻擴展(Contributed extensions):用戶在第二個存儲庫中貢獻的超過50個擴展; 其中大多數可以從PyPI安裝

.. _sphinx: http://www.sphinx-doc.org
.. _Pygments: http://pygments.org/
.. _更多參考: https://www.sphinx-doc.org/en/master/usage/extensions/#builtin-sphinx-extensions

.. toctree::
   :caption: 內文章節
   :numbered:
   :maxdepth: 3
   
   
   rst/installing_sphinx
   rst/getting_started
   rst/rst_tutorial
   rst/use_eclipse