From 9d8a453d2d352e734907f79bd9ac79d9c1446418 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <davbe125@student.liu.se>
Date: Thu, 2 Aug 2018 11:46:53 +0200
Subject: [PATCH] Add page on types
---
docs/index.rst | 3 +--
docs/types.rst | 20 ++++++++++++++++++++
2 files changed, 21 insertions(+), 2 deletions(-)
create mode 100644 docs/types.rst
diff --git a/docs/index.rst b/docs/index.rst
index 249f7f5..d00a0c0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -8,6 +8,7 @@ This is a Python module for implementing bots for Starcraft II.
:caption: Contents:
quickstart
+ types
unit
managers
playerconstants
@@ -35,8 +36,6 @@ Short overview
library.UNIT_TYPEID
library.UPGRADE_ID
library.Unit
- library.UnitType
- library.UnitTypeID
Indices and tables
==================
diff --git a/docs/types.rst b/docs/types.rst
new file mode 100644
index 0000000..834d8b9
--- /dev/null
+++ b/docs/types.rst
@@ -0,0 +1,20 @@
+Types
+=====
+
+For a full list of all unit types see the enum :class:`library.UNIT_TYPEID`.
+For more information about a certain unit type, the wrapper class
+:class:`library.UnitType` can be used.
+
+For a full list of all abilities and upgrades, see :class:`library.ABILITY_ID`
+and :class:`library.UPGRADE_ID` respectively. Note that these does not have any
+wrapper classes for them.
+
+UnitType
+--------
+
+As explained above, this class is a wrapper around the class
+:class:`library.UNIT_TYPEID`.
+
+.. autoclass:: library.UnitType
+ :members:
+ :undoc-members:
--
GitLab