added docs for root_dir

issp-center-dev · Apr 15, 2021 · 0dfc495 · 0dfc495
1 parent ec6146b
commit 0dfc495
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/doc/en/source/input.rst b/doc/en/source/input.rst
@@ -30,6 +30,12 @@ The input file consists of the following four sections.
 
   Description: Dimension of the search space (number of parameters to search)
 
+- ``root_dir``
+
+  Format: string (default: The directory where the program was executed)
+
+  Description: Name of the root directory. The origin of the relative paths to input files.
+
 - ``output_dir``
 
   Format: string (default: The directory where the program was executed)

diff --git a/doc/ja/source/input.rst b/doc/ja/source/input.rst
@@ -30,6 +30,13 @@ py2dmat は入力ファイルの形式に `TOML <https://toml.io/ja/>`_ を採
 
   説明: 探索空間の次元（探索するパラメータの数）
 
+- ``root_dir``
+
+  形式: string型 (default: プログラム実行時のディレクトリ)
+
+  説明: プログラムを実行する一番上のディレクトリ。
+        入力ファイルなどのパスはすべて ``root_dir`` を起点とします。
+
 - ``output_dir``
 
   形式: string型 (default: プログラム実行時のディレクトリ)