テーマ作成前の準備

実際にテーマを作成していく前に、必要なものと環境を準備します。

必要なファイル、ディレクトリ

テーマはテーマ名のついたディレクトリ、またはzipファイルで提供され、以下のファイルが含まれます。

theme.conf
テーマの設定ファイル
HTMLテンプレート
文書のレイアウトや表示する内容のひな形になるファイルレイアウトの変更時に必要に応じて用意する
staticディレクトリ
CSS、スクリプト、画像ファイル等の静的ファイルを配置するディレクトリ

このドキュメントでは、以降、テーマをディレクトリとして作成し解説していきます。

テーマ作成環境を作成する

作成するテーマ名の名前をつけたディレクトリは、conf.pyhtml_theme_pathで設定した場所に配置します。以下の例では、conf.pyと同じディレクトリ内にmythemeというテーマを作成します。

注釈

html_theme_pathは、conf.pyからの相対パスで指定して下さい。

html_theme = 'mytheme'
html_theme_path = ['.']

mythemeというディレクトリを作成し、その中でtheme.confstaticディレクトリ、htmlテンプレートを作成します。htmlテンプレートは、.htmlの拡張子が付いたファイルになります。

../../_images/dir.jpg

準備が整ったら、theme.confの作成に進んでください。