sphinx.ext.githubpages – 在 GitHub Pages 發佈 HTML 文件¶
版本 1.4 新增。
版本 2.0 變更：支援 CNAME 檔案
此擴充功能會在產生的 HTML 目錄中建立 .nojekyll 檔案，以便在 GitHub Pages 上發佈文件。
當設定 html_baseurl 時，它也會為自訂網域建立 CNAME 檔案。
基礎知識
使用者指南
sphinx.ext.apidoc – 從 Python 套件產生 API 文件sphinx.ext.autodoc – 包含來自 docstring 的文件sphinx.ext.autosectionlabel – 允許透過標題參照章節sphinx.ext.autosummary – 產生 autodoc 摘要sphinx.ext.coverage – 收集文件涵蓋率統計資訊sphinx.ext.doctest – 測試文件中的程式碼片段sphinx.ext.duration – 測量 Sphinx 處理時間sphinx.ext.extlinks – 縮短外部連結的標記sphinx.ext.githubpages – 在 GitHub Pages 發佈 HTML 文件sphinx.ext.graphviz – 新增 Graphviz 圖表sphinx.ext.ifconfig – 根據設定包含內容sphinx.ext.imgconverter – 使用 Imagemagick 的參考圖片轉換器sphinx.ext.inheritance_diagram – 包含繼承圖sphinx.ext.intersphinx – 連結到其他專案的文件sphinx.ext.linkcode – 新增外部連結到原始碼sphinx.ext.napoleon – 支援 NumPy 和 Google 風格的 docstringsphinx.ext.todo – 支援 todo 項目sphinx.ext.viewcode – 新增連結到已突顯的原始碼社群
參考
sphinx.ext.apidoc – 從 Python 套件產生 API 文件sphinx.ext.autodoc – 包含來自 docstring 的文件sphinx.ext.autosectionlabel – 允許透過標題參照章節sphinx.ext.autosummary – 產生 autodoc 摘要sphinx.ext.coverage – 收集文件涵蓋率統計資訊sphinx.ext.doctest – 測試文件中的程式碼片段sphinx.ext.duration – 測量 Sphinx 處理時間sphinx.ext.extlinks – 縮短外部連結的標記sphinx.ext.githubpages – 在 GitHub Pages 發佈 HTML 文件sphinx.ext.graphviz – 新增 Graphviz 圖表sphinx.ext.ifconfig – 根據設定包含內容sphinx.ext.imgconverter – 使用 Imagemagick 的參考圖片轉換器sphinx.ext.inheritance_diagram – 包含繼承圖sphinx.ext.intersphinx – 連結到其他專案的文件sphinx.ext.linkcode – 新增外部連結到原始碼sphinx.ext.napoleon – 支援 NumPy 和 Google 風格的 docstringsphinx.ext.todo – 支援 todo 項目sphinx.ext.viewcode – 新增連結到已突顯的原始碼sphinx.ext.githubpages – 在 GitHub Pages 發佈 HTML 文件¶版本 1.4 新增。
版本 2.0 變更：支援 CNAME 檔案
此擴充功能會在產生的 HTML 目錄中建立 .nojekyll 檔案，以便在 GitHub Pages 上發佈文件。
當設定 html_baseurl 時，它也會為自訂網域建立 CNAME 檔案。