From 67008b67d8064d00a449d9efb158f1b4cc9401b5 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Sun, 14 Feb 2021 19:26:10 +0100 Subject: [PATCH] doc/ide: include installation guide --- doc/api/start_ev3/index.rst | 2 +- doc/api/start_pup.rst | 4 +++- doc/ide/index.rst | 19 +++++++++++-------- doc/ide/start_pup.rst | 1 + 4 files changed, 16 insertions(+), 10 deletions(-) create mode 100644 doc/ide/start_pup.rst diff --git a/doc/api/start_ev3/index.rst b/doc/api/start_ev3/index.rst index bd0ebc8..b6898a2 100644 --- a/doc/api/start_ev3/index.rst +++ b/doc/api/start_ev3/index.rst @@ -1,4 +1,4 @@ -EV3 Quick Start +MINDSTORMS EV3 ######################## .. note:: diff --git a/doc/api/start_pup.rst b/doc/api/start_pup.rst index 46823c9..60f9732 100644 --- a/doc/api/start_pup.rst +++ b/doc/api/start_pup.rst @@ -1,4 +1,6 @@ -Powered Up Quick Start +.. _pupguide: + +Powered Up ######################## .. figure:: ../api/images/powereduphubs.png diff --git a/doc/ide/index.rst b/doc/ide/index.rst index bdf8ff8..97a757a 100644 --- a/doc/ide/index.rst +++ b/doc/ide/index.rst @@ -1,11 +1,12 @@ Pybricks Documentation ================================================================== -.. note:: +.. toctree:: + :maxdepth: 1 + :caption: Getting started + :hidden: - The installation guide and other documentation are available at - `docs.pybricks.com`_. This window contains only - documentation and examples for all available classes and methods. + start_pup .. toctree:: :maxdepth: 1 @@ -29,9 +30,13 @@ Pybricks Documentation motors Use the ☰ menu to navigate all available classes, methods, and tools. A few -commonly used devices are listed below for quick reference. +commonly used devices and classes are listed below for quick reference. -.. rubric:: Powered Up Hubs +.. rubric:: Installation + +Click :ref:`to jump to the installation guide `. + +.. rubric:: Programmable Hubs .. figure:: ../api/images/hubsoverview.png :width: 100 % @@ -42,5 +47,3 @@ commonly used devices are listed below for quick reference. .. figure:: ../api/images/pupdevicesoverview.png :width: 100 % :target: pupdevices/index.html - -.. _docs.pybricks.com: https://docs.pybricks.com/ diff --git a/doc/ide/start_pup.rst b/doc/ide/start_pup.rst new file mode 100644 index 0000000..00d0ed4 --- /dev/null +++ b/doc/ide/start_pup.rst @@ -0,0 +1 @@ +.. include:: ../api/start_pup.rst