Skip to content

Commit 97cdaf0

Browse files
shima004shima004
committed
feat: ADFコアPythonモジュールのドキュメントの修正
1 parent 08488a8 commit 97cdaf0

File tree

49 files changed

+1760
-7
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1760
-7
lines changed

‎docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Generate documentation
44

55
```bash
6-
sphinx-apidoc -f -o ./docs/source ./adf_core_python
7-
sphinx-build -M html ./docs/source ./docs/build -a
6+
sphinx-apidoc -f -o ./docs/source/adf_core_python ./adf_core_python
7+
sphinx-build -M html ./docs/source/adf_core_python ./docs/build -a
88
```

‎docs/build.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ def build_doc(version, language, tag):
1313
subprocess.run("git checkout main -- versions.yaml", shell=True)
1414
subprocess.run("doxygen Doxyfile", shell=True)
1515
os.environ['SPHINXOPTS'] = "-D language='{}'".format(language)
16-
subprocess.run("make html", shell=True)
16+
subprocess.run("make html", shell=True)
1717

18-
# a move dir method because we run multiple builds and bring the html folders to a
18+
# a move dir method because we run multiple builds and bring the html folders to a
1919
# location which we then push to github pages
2020
def move_dir(src, dst):
2121
subprocess.run(["mkdir", "-p", dst])
2222
subprocess.run("mv "+src+'* ' + dst, shell=True)
2323

2424
# to separate a single local build from all builds we have a flag, see conf.py
2525
os.environ["build_all_docs"] = str(True)
26-
os.environ["pages_root"] = "https://adf-python.github.io/adf-core-python/"
26+
os.environ["pages_root"] = "https://adf-python.github.io/adf-core-python/"
2727

2828
# manually the main branch build in the current supported languages
2929
build_doc("latest", "en", "main")
30-
move_dir("./build/html/", "./pages/")
30+
move_dir("./build/html/", "./pages/en")
3131
build_doc("latest", "ja", "main")
3232
move_dir("./build/html/", "./pages/ja/")
3333

@@ -38,6 +38,6 @@ def move_dir(src, dst):
3838
# and looping over all values to call our build with version, language and its tag
3939
# for version, details in docs.items():
4040
# tag = details.get('tag', '')
41-
# for language in details.get('languages', []):
41+
# for language in details.get('languages', []):
4242
# build_doc(version, language, version)
4343
# move_dir("./build/html/", "./pages/"+version+'/'+language+'/')

‎docs/source/adf_core_python/adf_core_python.cli.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
adf\_core\_python.cli package
2+
=============================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.cli.cli module
8+
--------------------------------
9+
10+
.. automodule:: adf_core_python.cli.cli
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: adf_core_python.cli
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.action.ambulance.rst

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
adf\_core\_python.core.agent.action.ambulance package
2+
=====================================================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.core.agent.action.ambulance.action\_load module
8+
-----------------------------------------------------------------
9+
10+
.. automodule:: adf_core_python.core.agent.action.ambulance.action_load
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
adf\_core\_python.core.agent.action.ambulance.action\_rescue module
16+
-------------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.action.ambulance.action_rescue
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
adf\_core\_python.core.agent.action.ambulance.action\_unload module
24+
-------------------------------------------------------------------
25+
26+
.. automodule:: adf_core_python.core.agent.action.ambulance.action_unload
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: adf_core_python.core.agent.action.ambulance
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.action.common.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
adf\_core\_python.core.agent.action.common package
2+
==================================================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.core.agent.action.common.action\_move module
8+
--------------------------------------------------------------
9+
10+
.. automodule:: adf_core_python.core.agent.action.common.action_move
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
adf\_core\_python.core.agent.action.common.action\_rest module
16+
--------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.action.common.action_rest
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: adf_core_python.core.agent.action.common
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.action.fire.rst

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
adf\_core\_python.core.agent.action.fire package
2+
================================================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.core.agent.action.fire.action\_extinguish module
8+
------------------------------------------------------------------
9+
10+
.. automodule:: adf_core_python.core.agent.action.fire.action_extinguish
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
adf\_core\_python.core.agent.action.fire.action\_refill module
16+
--------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.action.fire.action_refill
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
adf\_core\_python.core.agent.action.fire.action\_rescue module
24+
--------------------------------------------------------------
25+
26+
.. automodule:: adf_core_python.core.agent.action.fire.action_rescue
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: adf_core_python.core.agent.action.fire
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.action.police.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
adf\_core\_python.core.agent.action.police package
2+
==================================================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.core.agent.action.police.action\_clear module
8+
---------------------------------------------------------------
9+
10+
.. automodule:: adf_core_python.core.agent.action.police.action_clear
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
adf\_core\_python.core.agent.action.police.action\_clear\_area module
16+
---------------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.action.police.action_clear_area
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: adf_core_python.core.agent.action.police
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.action.rst

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
adf\_core\_python.core.agent.action package
2+
===========================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
adf_core_python.core.agent.action.ambulance
11+
adf_core_python.core.agent.action.common
12+
adf_core_python.core.agent.action.fire
13+
adf_core_python.core.agent.action.police
14+
15+
Submodules
16+
----------
17+
18+
adf\_core\_python.core.agent.action.action module
19+
-------------------------------------------------
20+
21+
.. automodule:: adf_core_python.core.agent.action.action
22+
:members:
23+
:undoc-members:
24+
:show-inheritance:
25+
26+
Module contents
27+
---------------
28+
29+
.. automodule:: adf_core_python.core.agent.action
30+
:members:
31+
:undoc-members:
32+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.communication.rst

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
adf\_core\_python.core.agent.communication package
2+
==================================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
adf_core_python.core.agent.communication.standard
11+
12+
Submodules
13+
----------
14+
15+
adf\_core\_python.core.agent.communication.message\_manager module
16+
------------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.communication.message_manager
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: adf_core_python.core.agent.communication
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.communication.standard.bundle.centralized.rst

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
adf\_core\_python.core.agent.communication.standard.bundle.centralized package
2+
==============================================================================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.core.agent.communication.standard.bundle.centralized.command\_ambulance module
8+
------------------------------------------------------------------------------------------------
9+
10+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.centralized.command_ambulance
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
adf\_core\_python.core.agent.communication.standard.bundle.centralized.command\_fire module
16+
-------------------------------------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.centralized.command_fire
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
adf\_core\_python.core.agent.communication.standard.bundle.centralized.command\_police module
24+
---------------------------------------------------------------------------------------------
25+
26+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.centralized.command_police
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
adf\_core\_python.core.agent.communication.standard.bundle.centralized.command\_scout module
32+
--------------------------------------------------------------------------------------------
33+
34+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.centralized.command_scout
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
adf\_core\_python.core.agent.communication.standard.bundle.centralized.message\_report module
40+
---------------------------------------------------------------------------------------------
41+
42+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.centralized.message_report
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.centralized
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎docs/source/adf_core_python/adf_core_python.core.agent.communication.standard.bundle.information.rst

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
adf\_core\_python.core.agent.communication.standard.bundle.information package
2+
==============================================================================
3+
4+
Submodules
5+
----------
6+
7+
adf\_core\_python.core.agent.communication.standard.bundle.information.message\_ambulance\_team module
8+
------------------------------------------------------------------------------------------------------
9+
10+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information.message_ambulance_team
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
adf\_core\_python.core.agent.communication.standard.bundle.information.message\_building module
16+
-----------------------------------------------------------------------------------------------
17+
18+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information.message_building
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
adf\_core\_python.core.agent.communication.standard.bundle.information.message\_civilian module
24+
-----------------------------------------------------------------------------------------------
25+
26+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information.message_civilian
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
adf\_core\_python.core.agent.communication.standard.bundle.information.message\_fire\_brigade module
32+
----------------------------------------------------------------------------------------------------
33+
34+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information.message_fire_brigade
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
adf\_core\_python.core.agent.communication.standard.bundle.information.message\_police\_force module
40+
----------------------------------------------------------------------------------------------------
41+
42+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information.message_police_force
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
adf\_core\_python.core.agent.communication.standard.bundle.information.message\_road module
48+
-------------------------------------------------------------------------------------------
49+
50+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information.message_road
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
Module contents
56+
---------------
57+
58+
.. automodule:: adf_core_python.core.agent.communication.standard.bundle.information
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:

0 commit comments

Comments
 (0)