From 27ebb1bf2ed11f88430bf99b6e8162531d5e75d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <davbe125@student.liu.se>
Date: Fri, 3 Aug 2018 13:21:19 +0200
Subject: [PATCH] Quickstart -> Getting started
---
docs/{quickstart.rst => gettingstarted.rst} | 6 ++++--
docs/idabot.rst | 4 +++-
docs/index.rst | 11 ++++++++---
docs/managers.rst | 2 ++
4 files changed, 17 insertions(+), 6 deletions(-)
rename docs/{quickstart.rst => gettingstarted.rst} (98%)
diff --git a/docs/quickstart.rst b/docs/gettingstarted.rst
similarity index 98%
rename from docs/quickstart.rst
rename to docs/gettingstarted.rst
index ff385355c..c8c6e1f9f 100644
--- a/docs/quickstart.rst
+++ b/docs/gettingstarted.rst
@@ -1,7 +1,9 @@
.. TODO: How should we host the binaries
-Creating your first bot
-=======================
+.. _gettingstarted:
+
+Getting started
+===============
The goal of this page is to get you quickly started using the API. The
following code block is the bare minimum you need to start Starcraft II and run
diff --git a/docs/idabot.rst b/docs/idabot.rst
index 7ed0a0fb1..823ceee8b 100644
--- a/docs/idabot.rst
+++ b/docs/idabot.rst
@@ -1,12 +1,14 @@
IDABot
======
+.. TODO: Missing methods: on_start, on_step
+
.. class:: library.IDABot
This is the basis of your bot. It contains all available managers and some
methods to get you started.
- See :doc:`this page <quickstart>` for how to properly
+ See :ref:`this page <gettingstarted>` for how to properly
inherit from IDABot.
Instances of managers:
diff --git a/docs/index.rst b/docs/index.rst
index 68c21e31f..87dc4a92c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,13 +3,18 @@ Welcome to PyCommandCenter's documentation!
This is a Python library based on the CommandCenter bot for implementing bots for Starcraft II.
-.. TODO: IDABot in toctree
+If you are looking on how to get started, take a look at :ref:`Getting
+started <gettingstarted>`.
+
+.. TODO: Coordinates explained
+
+Table of contents
+-----------------
.. toctree::
:maxdepth: 2
- :caption: Contents:
- quickstart
+ gettingstarted
managers
idabot
unit
diff --git a/docs/managers.rst b/docs/managers.rst
index 8e34aa85c..97d32ead4 100644
--- a/docs/managers.rst
+++ b/docs/managers.rst
@@ -47,6 +47,8 @@ BaseLocationManager
.. attribute:: library.BaseLocation.position
The position of the center of the BaseLocation, defined as a :class:`library.Point2D`.
+ This is the position used if you want to build a Command Center at the
+ base location.
.. attribute:: library.BaseLocation.depot_position
--
GitLab