讓我們來談談 Jamstack 的未來 — 加入我們

Sphinx

5646 個星標
1864 個 fork
1128 個 issue
首頁
https://sphinx-doc.dev.org.tw/
儲存庫
sphinx-doc/sphinx
程式語言
Python
授權條款
BSD-2-Clause
樣板
Jinja2

Sphinx 是一個工具,可以輕鬆建立智慧且美觀的文件,由 Georg Brandl 編寫並以 BSD 授權條款授權。

它最初是為新的 Python 文件而建立的,並且具有出色的 Python 專案文件功能,但目前也支援 C/C++,並且計劃增加對其他語言的特殊支援。當然,這個網站也是使用 Sphinx 從 reStructuredText 來源建立的! 以下功能應該特別強調

  • 輸出格式:HTML(包含 Windows HTML Help)、LaTeX(用於可列印的 PDF 版本)、ePub、Texinfo、手冊頁、純文字
  • 廣泛的交叉參考:語義標記和函數、類別、引文、詞彙表條目和類似資訊的自動連結
  • 階層式結構:易於定義文件樹,並自動連結到同級、父級和子級
  • 自動索引:一般索引以及特定於語言的模組索引
  • 程式碼處理:使用 Pygments highlight 的自動突顯
  • 擴充功能:程式碼片段的自動測試、從 Python 模組(API 文件)包含 docstring 等等
  • 使用者貢獻的擴充功能:在第二個儲存庫中由使用者貢獻的 50 多個擴充功能;大多數可以從 PyPI 安裝

Sphinx 使用 reStructuredText 作為其標記語言,它的許多優點來自於 reStructuredText 的強大功能和直接性,以及其解析和轉換套件 Docutils。

尋找更多靜態網站產生器