Chapter 01

まえがき

Takei Kazuya
Takei Kazuya
2021.02.09に更新
このチャプターの目次

はじめに

皆さんはSphinxを知っていますか?使っていますか?

SphinxはPython製のプレゼンテーションビルダーです。
reStructuredTextという形式のテキストファイルを束ねて、ドキュメント用HTMLなどを生成することが出来ます。
このツールはPython系のライブラリ類だけでなく、幅広いアプリケーションでも採用されています。

Sphinxは高い拡張性を持っており、「入力ソースの種類追加」「新しいreSTディレクティブの追加」「出力形式」の追加などをPythonで実装することが出来ます。

そんなSphinx拡張の中には、HTMLプレゼンテーションを出力するものがあります。
この本は、そんな拡張を使いつつ「Sphinxドキュメンテーションの知識でHTMLプレゼンテーションを公開する」ためのガイドブックとなっています。

対象読者

Sphinxでドキュメンテーションを書いている人。

  • Sphinxを使ったことがある。
  • reStructuredTextの文法を概要レベルで理解している
  • Pythonのコード読み書きできる
    • 全体として読める
    • 必要に応じて簡単な編集が出来る
  • GitHub のうち、リポジトリ・Pages・Actionsの概要を知っている

使う技術

本を書くにあたって、ソース類の再現確認等に使っている言語とバージョンです。
基本的には、ある程度前後しても動作はすると想定です。

  • Python 3.9.1
  • Sphinx 3.4.3
  • sphinx-revealjs 1.0.1
  • GitHub
    • Repository
    • Actions
    • Pages