ようこそ

ユーザは何と言いますか:

“;プログラマが本当に望む偉大なツールのために乾杯 文書を書きなさい!“;

ライオンの顔はスマートと美しさを簡単に作ることができるツールのようです 文書は,Georg Brandlによって作成され,BSD許可下で許可される.

最初はのために作成されました Python文書であり、優れたものを持っています ソフトウェア項目を多言語で記録する。vt.の もちろん,このサイトもreStrucureTextソースコードを用いて作成されている. スフィンクス!以下の特徴を強調すべきである。

  • 出力形式:HTML(Windows HTMLヘルプを含む)、LaTeX(使用 PDFバージョン)、ePub、Texinfo、マニュアルページ、プレーンテキストを印刷することができます。
  • 広範な交差引用:意味タグと自動リンク 関数、クラス、参照、用語、および類似の 情報
  • 階層構造:文書木を容易に定義し, 兄弟姉妹親子供に自動的にリンクします
  • 自動索引:一般索引および特定言語の索引 モジュールインデックス
  • コード処理:を用いて自動的に強調表示する Href=“http://pygments.org”>Pygmentsハイライトペン
  • 拡張:自動テストコードセグメントを含む Pythonモジュール(API文書)からの文書文字列、および より
  • 寄与の拡張:を超える 50個の拡張 は、ユーザによって提供される 第2のリポジトリでは、その多くはPyPIからインストール可能である

SphinxはreStrifredTextを使用する マークアップ言語としての多くの利点は強力なものから来ています ReStructiredTextの直接的性とその解析と翻訳 キットは、Docutilsである。

書類

SphinxドキュメントのPDF/EPUBバージョンもダウンロードできます 右下のポップアップメニューから。

実例.

Sphinxを用いて生成された文書へのリンクは a href="examples.html">は、Sphinxページを使用します。

Sphinxソースファイルの外観の例については、“;Showを使用してください それ以外にも,文書のすべてのページ上のソースリンクは ページを歓迎します。

あなたもとても良いかもしれません 以下の操作をどのように実行するかに関するチュートリアル Matplotlibで書かれたSphinxを用いてカスタム文書を作成する 開発業者です。

に翻訳チームがいる これはSphinx文書翻訳機のおかげだ。

O‘Reillyはライオンの顔像に関する日本語の本を出版しました スフィンクスをはじめとする/ ライオンの顔像を学ぶ。

2019年、ライオンの顔像に関するドイツ語書籍の第2版が出版された。 Software-Dokumentation MIT Sphinx

預かり金.

ライオンの顔写真ファイルを保管する場所が必要ですか? readthedocs.orgには多くのSphinx文書が保管されている また,プロジェクトのソースコード制御とうまく統合されている.また1つのものを持っています Sphinx JavaScriptによる機能を超えた強力な内蔵検索機能 オフラインで探索する。

投稿者案内

このプロジェクトに貢献したいなら この部分の文書はあなたのために用意されています。

“行動規則”

我々の行動基準を守ってください