Sphinx 使用手冊

譯者前言

?  Sphinx 文檔目錄   ::   Contents   ::   引言  ?

譯者前言

sphinx使用手冊,源文檔地址 Sphinx .

用戶評價: 值得歡呼的好工具,確實方便那些需要書寫文檔的程序員們!

歡迎

Sphinx 是一種文檔工具,它可以令人輕松的撰寫出清晰且優美的文檔, 由 Georg Brandl 在BSD 許可證下開發. 新版的Python文檔 就是由Sphinx生成的, 并且它已成為Python項目首選的文檔工具,同時它對 C/C++ 項目也有很好的支持; 并計劃對其它開發語言添加特殊支持. 本站當然也是使用 Sphinx 生成的,它采用reStructuredText! Sphinx還在繼續開發. 下面列出了其良好特性,這些特性在Python官方文檔中均有體現:

  • 豐富的輸出格式: 支持 HTML (包括 Windows 幫助文檔), LaTeX (可以打印PDF版本), manual pages(man 文檔), 純文本
  • 完備的交叉引用: 語義化的標簽,并可以自動化鏈接函數,類,引文,術語及相似的片段信息
  • 明晰的分層結構: 可以輕松的定義文檔樹,并自動化鏈接同級/父級/下級文章
  • 美觀的自動索引: 可自動生成美觀的模塊索引
  • 精確的語法高亮: 基于 Pygments 自動生成語法高亮
  • 開放的擴展: 支持代碼塊的自動測試,并包含Python模塊的自述文檔(API docs)等

Sphinx 使用 reStructuredText 作為標記語言, 可以享有 Docutils 為reStructuredText提供的分析,轉換等多種工具.

?  Sphinx 文檔目錄   ::   Contents   ::   引言  ?

四川快乐12开奖时间