Skip to content

Commit 703141c

Browse files
committed
feat: add Japanese localization and update documentation structure
1 parent cb03858 commit 703141c

File tree

8 files changed

+58
-67
lines changed

8 files changed

+58
-67
lines changed

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
source/adf_core_python.*

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
templates_path = ["_templates"]
3030
exclude_patterns = []
3131

32+
language = "ja"
3233

3334
# -- Options for HTML output -------------------------------------------------
3435
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
.. _example_index:
22

3-
Example Index
3+
44
=============
55

6-
Welcome to the example index for the ADF Core Python documentation. This section provides various examples to help you understand how to use the library effectively.
6+
ADF Core Python ドキュメントの例のインデックスへようこそ。このセクションでは、ライブラリの効果的な使用方法を理解するためのさまざまな例を提供します。
77

88
.. toctree::
99
:maxdepth: 2
10-
:caption: Examples
10+
:caption:
1111

1212
example1
1313
example2
1414
example3
15+

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Welcome to adf-core-python's documentation!
77
============================================
88

99
.. toctree::
10-
:maxdepth: 2
10+
:maxdepth: 3
1111
:caption: Contents:
1212

1313
introduction/introduction
Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
11
.. _installation:
22

3-
Installation
3+
インストール
44
============
55

6-
This section provides instructions on how to install the package.
6+
このセクションでは、パッケージのインストール方法について説明します。
77

8-
.. contents:: Table of Contents
8+
.. contents:: 目次
99
:depth: 2
1010
:local:
1111

12-
Prerequisites
13-
-------------
12+
前提条件
13+
--------
1414

15-
Before installing, ensure you have the following prerequisites:
15+
インストールする前に、以下の前提条件を確認してください:
1616

17-
- Python 3.6 or higher
17+
- Python 3.12 以上
1818
- pip
1919

20-
Installing the Package
21-
----------------------
20+
パッケージのインストール
21+
--------------------------
2222

23-
To install the package, run the following command:
23+
パッケージをインストールするには、次のコマンドを実行します:
2424

2525
.. code-block:: bash
2626
27-
pip install your-package-name
27+
pip install adf_core_python
2828
29-
Verifying the Installation
30-
--------------------------
29+
インストールの確認
30+
------------------
3131

32-
To verify the installation, you can run:
32+
インストールを確認するには、次のコマンドを実行します:
3333

3434
.. code-block:: bash
3535
36-
python -c "import your_package_name; print(your_package_name.__version__)"
36+
python -c "import adf_core_python; print(adf_core_python.__version__)"
3737
38-
If the package is installed correctly, this should print the version number of the package.
38+
パッケージが正しくインストールされている場合、パッケージのバージョン番号が表示されます。
3939

40-
Troubleshooting
41-
---------------
40+
トラブルシューティング
41+
-----------------------
4242

43-
If you encounter any issues during installation, please refer to the troubleshooting section or contact support.
43+
インストール中に問題が発生した場合は、トラブルシューティングセクションを参照するか、サポートに連絡してください。
Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,26 @@
11
.. _introduction:
22

3-
Introduction
4-
============
3+
イントロダクション
4+
==================
55

6-
Welcome to the ADF Core Python Documentation
6+
ADF Core Python ドキュメントへようこそ
77

8-
.. contents:: Table of Contents
8+
.. contents:: 目次
99
:depth: 2
1010
:local:
1111

1212
--------------------------------------------
1313

14-
This documentation is built using the `Sphinx <https://www.sphinx-doc.org/>`_ documentation generator and the `sphinx_book_theme <https://sphinx-book-theme.readthedocs.io/>`_.
14+
特徴
15+
----
1516

16-
Features
17-
--------
18-
19-
- **Easy to navigate**: The theme provides a clean and modern interface for your documentation.
20-
- **Responsive design**: Works well on both desktop and mobile devices.
21-
- **Search functionality**: Quickly find the information you need.
22-
23-
Getting Started
24-
---------------
25-
26-
To get started with ADF Core Python, follow the installation instructions and explore the examples provided in this documentation.
17+
- **モジュール単位での開発**: モジュール単位でエージェント開発を行い、モジュールの入れ替えが容易です。
18+
- **モジュールの再利用**: 他のエージェントで使用されているモジュールを再利用することができます。
19+
- **エージェントの開発に集中**: シミュレーションサーバーとの通信やログ出力などの共通処理をライブラリが提供します。
2720

28-
.. toctree::
29-
:maxdepth: 2
30-
:caption: Contents:
31-
32-
installation
33-
usage
34-
examples
35-
36-
Contributing
37-
------------
21+
はじめに
22+
--------
3823

39-
We welcome contributions! Please read our `contributing guide <../contributing.rst>`_ to learn how you can help.
24+
ADF Core Python を始めるには、インストール手順に従い、このドキュメントに記載されている例を参照してください。
4025

41-
Contact
42-
-------
4326

44-
If you have any questions or feedback, please reach out to us at `[email protected] <mailto:[email protected]>`_.

docs/source/modules.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
adf_core_python
2+
===============
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
adf_core_python

docs/source/usage/usage_index.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,36 @@
11
.. _usage_index:
22

3-
Usage
4-
=====
3+
使用方法
4+
========
55

6-
This section provides an overview of how to use the `adf-core-python` library.
6+
このセクションでは、`adf-core-python` ライブラリの使用方法の概要を提供します。
77

88
.. toctree::
99
:maxdepth: 2
10-
:caption: Contents:
10+
:caption: 目次:
1111

1212
installation
1313
quickstart
1414
examples
1515

16-
.. note::
17-
This documentation is built using the `sphinx_book_theme`.
1816

19-
Getting Started
20-
---------------
17+
はじめに
18+
--------
2119

22-
To get started with `adf-core-python`, follow the instructions in the sections below.
20+
`adf-core-python` を始めるには、以下のセクションの指示に従ってください。
2321

24-
Installation
22+
インストール
2523
------------
2624

2725
.. include:: installation.rst
2826

29-
Quickstart
30-
----------
27+
クイックスタート
28+
----------------
3129

3230
.. include:: quickstart.rst
3331

34-
Examples
35-
--------
32+
33+
--
3634

3735
.. include:: examples.rst
36+

0 commit comments

Comments
 (0)