GitHubじゃ!Pythonじゃ!

GitHubからPython関係の優良リポジトリを探したかったのじゃー、でも英語は出来ないから日本語で読むのじゃー、英語社会世知辛いのじゃー

sphinx-doc

sphinx – Sphinxドキュメントビルダー

投稿日:2018年3月21日 更新日:

Sphinxドキュメントビルダ http://sphinx-doc.orgの メインリポジトリ

スフィンクス

Sphinxは、Georgl Brandlによって書かれた、Pythonプロジェクト(または複数のreStructuredTextソースからなるその他の文書)のインテリジェントで美しい文書を簡単に作成できるツールです。 もともとは新しいPythonドキュメンテーションのために作られたもので、Pythonプロジェクトのドキュメンテーションのための優れた機能を備えていますが、C / C ++もサポートされており、さらに多くの言語が計画されています。

Sphinxはマークアップ言語としてreStructuredTextを使用しており、その強みの多くはreStructuredTextとその解析と翻訳スイートであるDocutilsの力と簡単さから生まれたものです。

その機能の中には以下のものがあります:

  • 出力形式:HTML(HTMLヘルプ、EpubおよびQtヘルプなどの派生形式を含む)、プレーンテキスト、マニュアルページ、LaTeXまたはrst2pdfを使用した直接PDF出力
  • 広範な相互参照:機能、クラス、用語集用語などの情報に対する意味的なマークアップと自動リンク
  • 階層構造:兄弟、親、子どもへの自動リンクによる文書ツリーの定義が容易
  • 自動インデックス:汎用インデックスとモジュールインデックス
  • コードの処理:Pygmentsのハイライターを使用した自動ハイライト
  • Jinja 2テンプレートエンジンを使用した柔軟なHTML出力
  • スニペットの自動テストや適切にフォーマットされたドキュメントストリングの挿入など、さまざまな拡張が利用できます
  • Setuptoolsの統合

詳細については、マニュアルを参照してください。

インストール

SphinxはPyPIで公開されており、そこからインストールすることができます:

pip install -U sphinx

ベータリリースも公開しています。

pip install -U --pre sphinx

開発目的でSphinxをインストールする場合は、寄稿者のガイドを参照してください

ドキュメンテーション

ドキュメントはsphinx-doc.orgから入手できます。

連絡する

テスト

継続的なテストは、 Travis (Linuxのユニットテストとスタイルチェック)、 AppVeyor (Windowsのユニットテスト)、 CircleCI (TeXコンパイルのような大規模なプロセス)によって提供されています。

テストをローカルで実行する方法については、寄稿者のガイドを参照してください

貢献する

貢献者ガイドを参照してください

リリース署名

リリースは以下のキーで署名されています:







-sphinx-doc
-, , ,

執筆者: