Skip to content

Commit 383d21a

Browse files
committed
docの自動更新スクリプトを修正
1 parent e4d16a7 commit 383d21a

19 files changed

Lines changed: 3953 additions & 158 deletions

.github/workflows/docs.yml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ on:
77
paths:
88
- 'docs/**'
99
- 'py2hackCraft/**'
10+
- 'conf.py'
11+
- 'index.rst'
1012
- '.github/workflows/docs.yml'
1113

1214
jobs:
@@ -27,12 +29,12 @@ jobs:
2729
2830
- name: Build documentation
2931
run: |
30-
cd docs
31-
make github
32+
make html
33+
cp -r _build/html/* docs/
3234
33-
- name: Deploy to GitHub Pages
34-
uses: peaceiris/actions-gh-pages@v3
35-
with:
36-
github_token: ${{ secrets.GITHUB_TOKEN }}
37-
publish_dir: ./docs
38-
publish_branch: gh-pages
35+
- name: Commit and push changes
36+
run: |
37+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
38+
git config --local user.name "github-actions[bot]"
39+
git add docs/
40+
git diff --quiet && git diff --staged --quiet || (git commit -m "Update documentation HTML" && git push)
571 KB
Binary file not shown.
9.69 KB
Binary file not shown.
7.27 KB
Binary file not shown.
10 KB
Binary file not shown.

_build/doctrees/environment.pickle

1.33 KB
Binary file not shown.

_build/doctrees/index.doctree

13.2 KB
Binary file not shown.
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
APIリファレンス
2+
============
3+
4+
このセクションでは、py2hackCraftの主要なクラスとメソッドについて説明します。
5+
6+
基本クラス
7+
-----------
8+
9+
Player
10+
~~~~~~
11+
12+
サーバーとの接続を管理するクラスです。
13+
14+
.. autoclass:: py2hackCraft.modules.Player
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
Entity
20+
~~~~~~
21+
22+
エンティティの操作を管理するクラスです。
23+
24+
.. autoclass:: py2hackCraft.modules.Entity
25+
:members:
26+
:undoc-members:
27+
:show-inheritance:
28+
29+
Volume
30+
~~~~~~
31+
32+
3次元の領域を表すクラスです。
33+
34+
.. autoclass:: py2hackCraft.modules.Volume
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
LocationFactory
40+
~~~~~~~~~~~~~
41+
42+
座標を生成するファクトリクラスです。
43+
44+
.. autoclass:: py2hackCraft.modules.LocationFactory
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:
48+
49+
データクラス
50+
-----------
51+
52+
Location
53+
~~~~~~~~
54+
55+
座標を表すデータクラスです。
56+
57+
.. autoclass:: py2hackCraft.modules.Location
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
61+
62+
Block
63+
~~~~~
64+
65+
ブロックの情報を表すクラスです。
66+
67+
.. autoclass:: py2hackCraft.modules.Block
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:
71+
72+
ItemStack
73+
~~~~~~~~
74+
75+
アイテムスタックの情報を表すクラスです。
76+
77+
.. autoclass:: py2hackCraft.modules.ItemStack
78+
:members:
79+
:undoc-members:
80+
:show-inheritance:
81+
82+
イベントクラス
83+
------------
84+
85+
InteractEvent
86+
~~~~~~~~~~~~
87+
88+
エンティティとの相互作用イベントを表すクラスです。
89+
90+
.. autoclass:: py2hackCraft.modules.InteractEvent
91+
:members:
92+
:undoc-members:
93+
:show-inheritance:
94+
95+
EventMessage
96+
~~~~~~~~~~~
97+
98+
イベントメッセージを表すクラスです。
99+
100+
.. autoclass:: py2hackCraft.modules.EventMessage
101+
:members:
102+
:undoc-members:
103+
:show-inheritance:
104+
105+
ChatMessage
106+
~~~~~~~~~~
107+
108+
チャットメッセージを表すクラスです。
109+
110+
.. autoclass:: py2hackCraft.modules.ChatMessage
111+
:members:
112+
:undoc-members:
113+
:show-inheritance:
114+
115+
RedstonePower
116+
~~~~~~~~~~~~
117+
118+
レッドストーンの出力レベルを表すクラスです。
119+
120+
.. autoclass:: py2hackCraft.modules.RedstonePower
121+
:members:
122+
:undoc-members:
123+
:show-inheritance:
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
py2hackCraft ドキュメントへようこそ!
2+
=====================================
3+
4+
py2hackCraftは、hackCraft2サーバーと対話するためのPythonクライアントライブラリです。
5+
このライブラリを使用することで、PythonからMinecraftの世界を操作することができます。
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
:caption: 目次:
10+
11+
installation
12+
quickstart
13+
api_reference
14+
examples
15+
16+
インストール
17+
-----------
18+
19+
py2hackCraftのインストール方法については、:doc:`installation` を参照してください。
20+
21+
クイックスタート
22+
--------------
23+
24+
基本的な使用方法については、:doc:`quickstart` を参照してください。
25+
26+
APIリファレンス
27+
-------------
28+
29+
詳細なAPIリファレンスについては、:doc:`api_reference` を参照してください。
30+
31+
Indices and tables
32+
==================
33+
34+
* :ref:`genindex`
35+
* :ref:`modindex`
36+
* :ref:`
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
インストール
2+
============
3+
4+
必要条件
5+
-----------
6+
7+
- Python 3.7以上
8+
- pip(Pythonパッケージインストーラー)
9+
10+
インストール方法
11+
-----------
12+
13+
pipを使用してpy2hackCraftをインストールできます:
14+
15+
.. code-block:: bash
16+
17+
pip install py2hackCraft
18+
19+
開発用インストール
20+
----------------------
21+
22+
開発モードでパッケージをインストールする場合:
23+
24+
1. リポジトリのクローン:
25+
.. code-block:: bash
26+
27+
git clone https://github.com/yourusername/hackCraft2-python.git
28+
cd hackCraft2-python
29+
30+
2. 開発モードでインストール:
31+
.. code-block:: bash
32+
33+
pip install -e .
34+
35+
これにより、パッケージが「編集可能」モードでインストールされ、ソースコードを修正した際に再インストールすることなく変更をすぐに反映できます。

0 commit comments

Comments
 (0)