Contents Menu Expand Light mode Dark mode Auto light/dark mode
PyCon JP TV #25 sample project documentation
Logo
PyCon JP TV #25 sample project documentation

Contents:

  • Sphinxとは
  • Quickstart
  • カスタマイズ
  • markdown対応
  • テーマを変える
  • Read the Docs でデプロイする
  • おすすめ拡張機能
  • テストドキュメント
Back to top
Edit this page

Sphinxとは#

  • Sphinxの紹介: https://www.sphinx-doc.org/ja/master/

  • Python製のドキュメント生成ツール

  • HTMLやepub、PDFなどに出力できる

  • 静的サイトジェネレーター

Sphinxを使っているサイトの紹介#

  • Sphinxを使用しているプロジェクト — Sphinx documentation

  • Python公式ドキュメント

  • Flake8ドキュメント

  • PEP 0 – Index of Python Enhancement Proposals (PEPs) | peps.python.org

Next
Quickstart
Previous
Home
Copyright © 2023, takanory
Made with Sphinx and @pradyunsg's Furo
On this page
  • Sphinxとは
    • Sphinxを使っているサイトの紹介