ようこそ!¶
Sphinx makes it easy to create intelligent and beautiful documentation.
Here are some of Sphinx's major features:
Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text
Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
Automatic indices: general index as well as a language-specific module indices
Code handling: automatic highlighting using the Pygments highlighter
Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs) via built-in extensions, and much more functionality via third-party extensions.
Themes: modify the look and feel of outputs via creating themes, and reuse many third-party themes.
Contributed extensions: dozens of extensions contributed by users; most of them installable from PyPI.
Sphinx uses the reStructuredText markup language by default, and can read MyST markdown via third-party extensions. Both of these are powerful and straightforward to use, and have functionality for complex documentation and publishing workflows. They both build upon Docutils to parse and write documents.
See below for how to navigate Sphinx's documentation.
参考
The Sphinx documentation Table of Contents has a full list of this site's pages.
Get started¶
These sections cover the basics of getting started with Sphinx, including creating and building your own documentation from scratch.
User Guides¶
These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx. If you are new to Sphinx, we recommend starting with Get started.
Community guide¶
Sphinx is community supported and welcomes contributions from anybody. The sections below should help you get started joining the Sphinx community as well as contributing.
See the Sphinx contributors' guide if you would like to contribute to the project.
Reference guide¶
Reference documentation is more complete and programmatic in nature, it is a collection of information that can be quickly referenced. If you would like usecase-driven documentation, see Get started or User Guides.
- Command-Line Tools
- 設定
- プロジェクト情報
- 一般的な設定
- 国際化のオプション
- Options for Math
- HTML出力のオプション
- Options for Single HTML output
- Options for HTML help output
- AppleHelp出力のオプション
- epub出力のオプション
- LaTeX出力のオプション
- テキスト出力のオプション
- manページ出力のオプション
- Texinfo出力のオプション
- Options for QtHelp output
- リンクチェックビルダーのオプション
- XML出力のオプション
- Options for the C domain
- C++ ドメインのオプション
- Options for the Python domain
- Options for the Javascript domain
- 設定ファイルの例
- 拡張
- reStructuredText
- 用語集
- Changelog
- Sphinxを使用しているプロジェクト
- alabasterテーマを使用しているドキュメント
- クラシックテーマを使用するドキュメント
- sphinxdocテーマを使用しているドキュメント
- ネイチャーテーマを使用するドキュメント
- その他の組み込みテーマを使用しているドキュメント
- sphinx_rtd_themeを使用したドキュメント
- sphinx_bootstrap_themeを使用したドキュメント
- Documentation using pydata_sphinx_theme
- カスタムテーマを使用したドキュメント、またはWebサイトに統合されたドキュメント
- ホームページや、ドキュメント以外のサイト
- Sphinxを使って書かれた書籍
- Sphinxを用いて作製した論文
- Sphinxの機能を統合したプロジェクト