File Structure

Structure

Wiki
 ├── docs
 │     ├── build
 │     │    ├── directory
 │     │    ├── index.html <-- 変換されたHTMLファイル
 │     │    └── ...
 │     ├── source
 │     │    ├── _static
 │     │    │    ├── css
 │     │    │    └── img
 │     │    ├── _templates
 │     │    ├── directory            <-- その他ページのファイル
 │     │    │    ├── quickstart.rst
 │     │    │    └── 10minutes.md
 │     │    ├── conf.py              <-- 設定ファイル
 │     │    └── index.rst            <-- メインページとなるファイル
 │     ├── Makefile
 │     └── ...
 ├── pyproject.toml  <-- poetryで使用
 └── ...

Config

設定ファイル（conf.py）は，Pythonで記述する．

主な設定

• project名

• sphinx拡張

• メイン言語

• テーマ（外観）

  • ロゴ

  • ヘッダの詳細

• 使用するCSS

• ファビコン

• etc.