Add docs page with links to example scripts

ExcaliburZero · Oct 17, 2023 · 9892e61 · 9892e61
1 parent 3f46b9f
commit 9892e61
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/source/python_api/example_scripts.rst b/docs/source/python_api/example_scripts.rst
@@ -0,0 +1,8 @@
+Example scripts
+===============
+Below are some examples of scripts that use `cbpickaxe`:
+
+* `get_move_users.py <https://github.com/ExcaliburZero/cbpickaxe/blob/master/cbpickaxe_scripts/get_move_users.py>`_
+* `generate_monster_animations.py <https://github.com/ExcaliburZero/cbpickaxe/blob/master/cbpickaxe_scripts/generate_monster_animations.py>`_
+* `extract_translation.py <https://github.com/ExcaliburZero/cbpickaxe/blob/master/cbpickaxe_scripts/extract_translation.py>`_
+* `generate_docs.py <https://github.com/ExcaliburZero/cbpickaxe/blob/master/cbpickaxe_scripts/generate_docs.py>`_
diff --git a/docs/source/python_api/intro.rst b/docs/source/python_api/intro.rst
@@ -17,4 +17,5 @@ Python API
    :maxdepth: 2
 
    tutorial
+   example_scripts
    classes_and_methods