intra-mart Accel Platform intra-mart Sphinxドキュメント ビルド手順書 第2版 2016-09-01

5. ドキュメントのディレクトリ構成と各種ファイル

  • カスタマイズを行うにあたってディレクトリ構成と各種ファイルについて説明します。

5.1. ディレクトリ構成

  • 主要なディレクトリとファイル

    ─  [ドキュメントプロジェクトのルートディレクトリ]
          ├─source
          │   ├─ texts
          │   │  └─ *.rst
          │   ├─ index.rst
          │   ├─ conf.py
          │   └─ dictionary.txt
          │
          ├─common_all
          │     └─ sources
          │        ├─ dictionary.txt
          │        └─ link_dictionary.txt
          │
          └─common_module
                └─ sources
                   └─ dictionary.txt
    
    • sourceディレクトリ

      実際のドキュメントのページとなるファイル群が含まれているディレクトリ
    • common_allディレクトリ

      intra-mart全ドキュメントで共通利用する辞書ファイル等の格納ディレクトリ
      通常は、SVN上の別ディレクトリ上で管理され、外部参照する事で一元管理します。
    • common_moduleディレクトリ

      同一カテゴリ(機能)単位で共通利用する辞書ファイル等の格納ディレクトリ
      通常は、SVN上の別ディレクトリ上で管理され、外部参照する事で一元管理します。

5.2. 各ファイル

5.2.1. conf.py ファイル

  • ドキュメントを構成するための定義ファイルです。

5.2.2. テーマ

  • source/conf.pyファイル「html_theme」要素で設定しています。
    現在設定されているテーマは、intra-martオリジナルのテーマです。他のテーマに変更する事も可能です。

5.2.3. rst ファイル

  • ドキュメントの内容が表示されるソースファイルです。