Sphinx における文章作成

Sphinx における文章作成の場合、通常のワープロのように一つの文章を一つのファイルで編集するというよりは 一つの文章をdirectory単位で行う。以下はコンパイル後の文章フォルダーのdirectory構造。

そこで、最初に文章に対するdirectory等の設定を、pyhonのユーティリティソフトを用いて、 より簡便に文章を作成する方法を紹介する。

文章作成フロー

  1. 新しい文章用の空directoryを作成し以下のテンプレートファイルをクリックしてダウンロードする。

    • report 用

修論、卒論作成の際はこちらのテンプレートファイルをダウンロードしてください

  • 卒論、修論用

操作方法は下と同じです

図のテーブルを作成したい時(python3対応）

注釈

conda3-5.3.1での注意点

conda3-5.3.1で行うときは、予め:

$ conda install recommonmark
$ conda install nbsphinx -c conda-forge
$ conda install sphinx_rtd_theme

でパッケージをインストールしておく。なお、actdiagとblockdiagは使えない

  1. 作りたいディレクトリで OpenTerminal を開き、以下のような操作を行うことで PCは文章作成の準備を完了する。

    $ python3 sphinx_report_20.04.py

    （以下は実行画面）

    digraph graph_name { node [shape=none,color="transparent"]d1 d2 d3; d1 [image="s-1.png",label=""] d2 [image="s-2.png",label=""]; d3 [image="s-3.png",label=""]; d1 -> d2 [label="タイトルと作成者を入力する"]; d2 -> d3 [label="Sphinx準備をクリックする"]; }

    図 1 sphinx_report_20.04.py の実行画面

  1. Restructured textを編集する。

    図 2 文章作成の概略

    ここでは、 source の下の index.rst を右 クリックしてeditorで開く。

    _images/s-6.png

  2. 文章のルートディレクトリーで OpenTerminal をひらき、以下の出力生成のコマンドのいずれかをを走らせる。

    $ make latexpdf   #pdf作成

$ make html       #html作成

  3. latex生成の際エラーが出て生成が止まってしまったら

    _images/halt.png 
    ?

    この時は Ctrl-Z で生成プロセスから抜けましょう。そして:

    $ make clean

    してから、間違った箇所を編集します。

  4. 出力を確認する。

    • Latexの場合

      buildファイルの中のlatexの下にpdfのファイルができ生成されたものが入っている。

      _images/s-5.png

    • htmlの場合

      buildの下にhtmlに index.html があるのでブラウザーで開く

      _images/s-5-2.png

警告

latex生成中にエラーで止まらなくても、ディレクティブの構文エラー（特に、数式や図など）があるときは 空白になっていることがある。