Merge pull request #82 from adf-python/fix/docs-tutorials

Fix/docs tutorials

Author: harrki

docs/source/images/launch_server.png

@@ -12,31 +12,48 @@ adf-core-pythonのドキュメント
 
 .. warning::
 
-   パッケージとしてまだ公開していないので、pip でインストールすることはできません。
+   パッケージとしてまだ公開していないため、pip でインストールすることはできません。
 
 
 .. contents:: 目次
    :depth: 2
    :local:
 
+概要
+----
+adf-core-pythonは、RoboCup Rescue Simulation(RRS)におけるエージェント開発を支援するためのライブラリ及びフレームワークです。
+adf-core-pythonを使用することで、エージェントの開発を効率化し、再利用性を向上させることができます。
+
 特徴
 ----
+adf-core-pythonには以下のような特徴があります。
 
 - **モジュール単位での開発**: モジュール単位でエージェント開発を行い、モジュールの入れ替えが容易です。
 - **モジュールの再利用**: 他のエージェントで使用されているモジュールを再利用することができます。
 - **エージェントの開発に集中**: シミュレーションサーバーとの通信やログ出力などの共通処理をライブラリが提供します。
 
 はじめに
 --------
+adf-core-pythonを始めるには、インストールに従い、このドキュメントに記載されているチュートリアルやハンズオンを参照してください。
+
+.. toctree::
+   :maxdepth: 1
+   :caption: インストール:
 
-ADF Core Python を始めるには、インストール手順に従い、このドキュメントに記載されている例を参照してください。
+   install/environment/environment
+   install/install/install
+
+.. toctree::
+   :maxdepth: 1
+   :caption: クイックスタート:
+
+   quickstart/quickstart
 
 .. toctree::
    :maxdepth: 1
    :caption: チュートリアル:
 
    tutorial/environment/environment
-   tutorial/install/install
    tutorial/agent/agent
    tutorial/agent/agent_control
    tutorial/config/config
@@ -46,14 +63,16 @@ ADF Core Python を始めるには、インストール手順に従い、この
    :maxdepth: 1
    :caption: ハンズオン:
 
-   hands-on/clustering
    hands-on/search
+   hands-on/clustering
 
 .. toctree::
    :maxdepth: 1
-   :caption: クイックスタート:
+   :caption: APIドキュメント:
 
-   quickstart/quickstart
+   genindex
+   modindex
+   search
 
 .. automodule:: adf_core_python
    :members:

docs/source/index.rst

@@ -0,0 +1,50 @@
+# 環境構築
+adf-core-pythonをインストールするには以下の必要条件が必要です。
+既にお使いのPCにインストールされている場合は再度インストールする必要はありません。
+
+## 必要条件
+
+- Git
+- Python 3.12 以上
+- OpenJDK 17
+
+各OSでのインストール方法は以下のページをそれぞれ参照してください
+
+[Windowsでの必要条件のインストール方法](./windows/install.md)
+
+[MacOSでの必要条件のインストール方法](./mac/install.md)
+
+[Linuxでの必要条件のインストール方法](./linux/install.md)
+
+## シミュレーションサーバーのインストール
+次にRoboCup Rescue Simulationのシミュレーションサーバーをインストールします。
+
+```{note}
+WORKING_DIR は任意のディレクトリを作成、指定してください。
+```
+
+```bash
+mkdir WORKING_DIR
+cd WORKING_DIR
+git clone https://github.com/roborescue/rcrs-server.git
+cd rcrs-server
+./gradlew completeBuild
+```
+
+ビルドした際に以下のようなメッセージが表示されたら成功です。
+
+```bash
+BUILD SUCCESSFUL in ...
+```
+
+## シミュレーションサーバーの動作確認
+
+```bash
+cd WORKING_DIR/rcrs-server/scripts
+./start-comprun.sh -m ../maps/test/map -c ../maps/test/config
+```
+
+![シミュレーションサーバーの起動](../../images/launch_server.png)
+
+上記のように何個かのウィンドウが表示されたら成功です。
+コマンドラインで `Ctrl + C`  (MacOSの場合は `Command + C` )  を押すとシミュレーションサーバーが終了します。

docs/source/install/environment/environment.md

@@ -0,0 +1,49 @@
+# Linuxでの環境構築
+
+## 1. Gitのインストール
+
+OS標準のパッケージマネージャーを使用してインストールします
+- DebianベースのOSの場合(Ubuntuなど)
+    ```bash
+    sudo apt install git
+    ```
+- Red HatベースのOSの場合(Fedoraなど)
+    ```bash
+    sudo yum install git
+    ```
+
+    ```bash
+    sudo dnf install git
+    ```
+
+## 2. Pythonのインストール
+
+OS標準のパッケージマネージャーを使用してインストールします
+- DebianベースのOSの場合(Ubuntuなど)
+    ```bash
+    sudo apt install python
+    ```
+- Red HatベースのOSの場合(Fedoraなど)
+    ```bash
+    sudo yum install python
+    ```
+
+    ```bash
+    sudo dnf install python
+    ```
+
+## 3. OpenJDKのインストール
+
+OS標準のパッケージマネージャーを使用してインストールします
+- DebianベースのOSの場合(Ubuntuなど)
+    ```bash
+    sudo apt install openjdk-17-jdk
+    ```
+- Red HatベースのOSの場合(Fedoraなど)
+    ```bash
+    sudo yum install java-17-openjdk
+    ```
+
+    ```bash
+    sudo dnf install java-17-openjdk-devel
+    ```

docs/source/install/environment/linux/install.md

@@ -0,0 +1,21 @@
+# Macでの環境構築
+
+## 1. Gitのインストール
+
+1. Terminalを起動します。
+2. XcodeのCommand Line Toolsをインストールします。
+    ```bash
+    xcode-select --install
+    ```
+
+## 2. Pythonのインストール
+
+1. [Python](https://www.python.org/downloads/)の公式サイトにアクセスします。
+2. ダウンロードページから最新のバージョンをダウンロードします。
+3. ダウンロードしたファイルを開き、インストールを開始します。
+
+## 3. OpenJDKのインストール
+
+1. [OpenJDK](https://jdk.java.net/archive/)の公式サイトにアクセスします。
+2. ダウンロードページから17.0.2のバージョンをダウンロードします。
+3. ダウンロードしたファイルを開き、インストールを開始します。

docs/source/install/environment/mac/install.md

@@ -56,7 +56,7 @@ python main.py
 ```
 
 エージェントが正常に起動すると、シミュレーションサーバーに接続され、エージェントがシミュレーションに参加し、エージェントが動き出します。
-途中で止めたい場合は、それぞれのコマンドラインで `Ctrl + C` を押してください。
+途中で止めたい場合は、それぞれのコマンドラインで `Ctrl + C` (MacOSの場合は `Command + C` ) を押してください。
 
 ```{warning}
 シミュレーションサーバーを停止させたあとは、プロセスが残ってしまう場合があるので`./kill.sh` を実行してください。

…/tutorial/environment/windows/install.md …e/install/environment/windows/install.mddocs/source/tutorial/environment/windows/install.md renamed to docs/source/install/environment/windows/install.md docs/source/tutorial/environment/windows/install.md renamed to docs/source/install/environment/windows/install.md

@@ -1,45 +1,19 @@
 # 環境構築
-
-## 必要なもの
-
-- Git
-- Python 3.12 以上
-- OpenJDK 17
-
-[Windowsでの必要なもののインストール方法](./windows/install.md)
-
-## シミュレーションサーバーのインストール
-
-```{note}
-WORKING_DIR は任意のディレクトリを指定してください。
-```
-
-```bash
-cd WORKING_DIR
-git clone https://github.com/roborescue/rcrs-server.git
-cd rcrs-server
-./gradlew completeBuild
-```
-
-ビルドした際に以下のようなメッセージが表示されたら成功です。
-
-```bash
-BUILD SUCCESSFUL in ...
-```
+今回はチュートリアル用のシナリオを使用してチュートリアルを行います。
 
 ## チュートリアルで使用するマップのダウンロード
 
 {download}`マップのダウンロード <./../../download/tutorial_map.zip>`
 をクリックしてダウンロードしてください。
 
-ダウンロードしたファイルを解凍し、中のファイルを `WORKING_DIR/rcrs-server/maps/` の中に移動させてください。
+ダウンロードしたファイルを解凍し、中のファイルを `rcrs-server/maps/` の中に移動させてください。
 
-## シュミレーションサーバーの動作確認
+## シミュレーションサーバーの動作確認
 
 ```bash
 cd WORKING_DIR/rcrs-server/scripts
 ./start-comprun.sh -m ../maps/tutorial_fire_brigade_only/map -c ../maps/tutorial_fire_brigade_only/config
 ```
 
 何個かのウィンドウが表示されたら成功です。
-コマンドラインで `Ctrl + C` を押すとシミュレーションサーバーが終了します。
+コマンドラインで `Ctrl + C` (MacOSの場合は `Command + C` ) を押すとシミュレーションサーバーが終了します。

docs/source/tutorial/install/install.md docs/source/install/install/install.mddocs/source/tutorial/install/install.md renamed to docs/source/install/install/install.md

@@ -60,7 +60,7 @@ class SampleSearch(Search):
             ),
         )
 
-        # モジュールの登録(これをしないと、モジュール内のシュミレーション環境の情報が更新されません)
+        # モジュールの登録(これをしないと、モジュール内のシミュレーション環境の情報が更新されません)
         self.register_sub_module(self._clustering)
         self.register_sub_module(self._path_planning)
 ```