tips:sphinx:start
差分
このページの2つのバージョン間の差分を表示します。
| 両方とも前のリビジョン前のリビジョン次のリビジョン | 前のリビジョン | ||
| tips:sphinx:start [2022/03/16 07:00] – [環境構築] yuuho | tips:sphinx:start [2022/03/16 08:06] (現在) – [設定の変更など] yuuho | ||
|---|---|---|---|
| 行 83: | 行 83: | ||
| - ./build/ | - ./build/ | ||
| - ./source/ | - ./source/ | ||
| + | - ./ | ||
| + | - ./ | ||
| + | - ./ | ||
| + | - ./ | ||
| - ./make.bat | - ./make.bat | ||
| - ./Makefile | - ./Makefile | ||
| 行 88: | 行 92: | ||
| となった。 | となった。 | ||
| - | === ページの生成 === | + | ==== ページの生成 |
| + | === 生成 === | ||
| '' | '' | ||
| + | === 結果 === | ||
| 実行したディレクトリを '' | 実行したディレクトリを '' | ||
| < | < | ||
| 行 99: | 行 105: | ||
| - ./ | - ./ | ||
| - ./source/ | - ./source/ | ||
| + | - ./ | ||
| + | - ./ | ||
| + | - ./ | ||
| + | - ./ | ||
| - ./make.bat | - ./make.bat | ||
| - ./Makefile | - ./Makefile | ||
| 行 104: | 行 114: | ||
| となった。 | となった。 | ||
| - | === メモ | + | ===== 開発 ===== |
| + | '' | ||
| + | なので、 '' | ||
| + | -> github pages は jekyll というソフトで実装されているため相対リンクなどを有効にするために特殊な設定が必要。\\ | ||
| + | -> 拡張機能を入れるべし。 | ||
| - | 何を git 管理するべき？ | ||
| - | '' | + | ===== 設定の変更など ===== |
| - | なので、 '' | + | |
| + | === メモ === | ||
| github-pages で公開する場合はすべてのファイルを相対リンク？するように拡張機能を入れるのが良さそう。 | github-pages で公開する場合はすべてのファイルを相対リンク？するように拡張機能を入れるのが良さそう。 | ||
| [[https:// | [[https:// | ||
| + | * 拡張機能 | ||
| + | * '' | ||
| + | * ''" | ||
| + | === メモ2 === | ||
| + | |||
| + | < | ||
| + | .. hoge:: | ||
| + | </ | ||
| + | みたいな感じで hoge 機能を使える。 | ||
| + | 使える機能としては '' | ||
| + | < | ||
| + | .. fuga fuga piyo piyo | ||
| + | </ | ||
| + | で単純にコメントを書く。 | ||
| + | |||
| + | === メモ3 === | ||
| + | |||
| + | よく使われているテーマ。 | ||
| + | [[https:// | ||
| + | |||
| + | <code bash>pip install sphinx-rtd-theme</ | ||
| + | |||
| + | <code python conf.py> | ||
| + | extensions = [ | ||
| + | ' | ||
| + | ' | ||
| + | ' | ||
| + | ' | ||
| + | ' | ||
| + | ] | ||
| + | html_theme = ' | ||
| + | </ | ||
tips/sphinx/start.1647414051.txt.gz · 最終更新: 2022/03/16 07:00 by yuuho