sphinx - Sphinxドキュメントビルダーのメインリポジトリ

(Main repository for the Sphinx documentation builder)

Created at: 2015-01-02 18:53:28
Language: Python
License: NOASSERTION

========スフィンクス

.. image :: https://img.shields.io/pypi/v/sphinx.svg:target:https://pypi.org/project/Sphinx/:alt:PyPI パッケージ

.. image :: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg:target:https://github.com/sphinx-doc/sphinx/actions/workflows /main.yml:alt :ビルドステータス

.. image :: https://readthedocs.org/projects/sphinx/badge/?version=master:target:https://www.sphinx-doc.org/:alt ドキュメント のステータス

.. image :: https://img.shields.io/badge/License-BSD%202--Clause-blue.svg:target:https://opensource.org/licenses/BSD-2-Clause:alt :BSD2条項

Sphinxを使用すると、インテリジェントで美しいドキュメントを簡単に作成できます。

Sphinxはマークアップ言語としてreStructuredTextを使用しており、その長所の多くは、reStructuredTextとその解析および翻訳スイートであるDocutilsのパワーとわかりやすさにあります。

特徴

  • 出力形式:HTML、PDF、プレーンテキスト、EPUB、TeX、マニュアルページなど
  • 広範な相互参照:関数、クラス、用語集用語、および同様の情報のセマンティックマークアップと自動リンク
  • 階層構造:兄弟、親、子への自動リンクを備えた、ドキュメントツリーの簡単な定義
  • 自動インデックス:一般インデックスとモジュールインデックス
  • コードの強調表示:Pygments蛍光ペンを使用した自動強調表示
  • テンプレート:Jinja2テンプレートエンジンを使用した柔軟なHTML出力
  • 拡張エコシステム:自動機能ドキュメントやJupyterノートブックの操作など、多くの拡張機能を利用できます。
  • 言語サポート:Python、C、C ++、JavaScript、数学、および拡張機能を介した他の多くの言語。

詳細については、

the documentation
_を参照してください。

インストール

Python Package Index
次のコマンドは、 _からSphinxをインストールします。Pythonとpipの実用的なインストールが必要になります。

..コードブロック::sh

pip install -U sphinx

貢献

すべての貢献に感謝します!詳細については、

the contributors guide
_を参照してください。

リリース署名

リリースは次のキーで署名されています。

  • 498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>
    _
  • 5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>
    _
  • 61F0FB52 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x52C8F72A61F0FB52>
    _

.. _ドキュメント:https : //www.sphinx-doc.org/ .. _寄稿者ガイド:https : //www.sphinx-doc.org/en/master/internals/contributing.html .. _Python Package Index:https://pypi.org/project/Sphinx/