From 853b1411532f0eb6de37fc4e18c38802ee426ee0 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Mon, 18 Jan 2021 11:44:56 +0100 Subject: [PATCH] doc/start_ev3: group as folder --- doc/api/index.rst | 4 ++-- doc/api/{start_ev3.rst => start_ev3/index.rst} | 0 doc/api/{ => start_ev3}/start_ev3_brick.inc | 8 ++++---- doc/api/{ => start_ev3}/start_ev3_download.inc | 0 doc/api/{ => start_ev3}/start_ev3_install.inc | 6 +++--- doc/api/{ => start_ev3}/start_ev3_linux.inc | 2 +- doc/api/{ => start_ev3}/start_ev3_run.inc | 18 +++++++++--------- doc/api/{ => start_ev3}/start_ev3_upgrade.inc | 4 ++-- 8 files changed, 21 insertions(+), 21 deletions(-) rename doc/api/{start_ev3.rst => start_ev3/index.rst} (100%) rename doc/api/{ => start_ev3}/start_ev3_brick.inc (91%) rename doc/api/{ => start_ev3}/start_ev3_download.inc (100%) rename doc/api/{ => start_ev3}/start_ev3_install.inc (96%) rename doc/api/{ => start_ev3}/start_ev3_linux.inc (98%) rename doc/api/{ => start_ev3}/start_ev3_run.inc (91%) rename doc/api/{ => start_ev3}/start_ev3_upgrade.inc (97%) diff --git a/doc/api/index.rst b/doc/api/index.rst index 9bb71a1..a90fccc 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -18,7 +18,7 @@ the platforms below. - **SPIKE / MINDSTORMS Inventor** * - .. image:: images/ev3brick.png - :target: start_ev3.html + :target: start_ev3/index.html - .. figure:: images/powereduphubs.png :target: start_pup.html @@ -63,7 +63,7 @@ findings on our `support page`_ so we can make Pybricks even better. :caption: Getting started :hidden: - start_ev3 + start_ev3/index start_pup start_inventor diff --git a/doc/api/start_ev3.rst b/doc/api/start_ev3/index.rst similarity index 100% rename from doc/api/start_ev3.rst rename to doc/api/start_ev3/index.rst diff --git a/doc/api/start_ev3_brick.inc b/doc/api/start_ev3/start_ev3_brick.inc similarity index 91% rename from doc/api/start_ev3_brick.inc rename to doc/api/start_ev3/start_ev3_brick.inc index 2b2ebab..33d7b59 100644 --- a/doc/api/start_ev3_brick.inc +++ b/doc/api/start_ev3/start_ev3_brick.inc @@ -6,7 +6,7 @@ into the microSD card slot on the EV3 Brick, as shown in :numref:`fig_sd`. .. _fig_sd: -.. figure:: ../api/images/sd_label.png +.. figure:: ../../api/images/sd_label.png :width: 75 % :alt: sd :align: center @@ -30,7 +30,7 @@ in :numref:`fig_onoff`. .. _fig_onoff: -.. figure:: ../api/images/onoff_label.png +.. figure:: ../../api/images/onoff_label.png :width: 65 % :alt: onoff :align: center @@ -45,7 +45,7 @@ the device browser, as shown in :numref:`fig_devicebrowser`. .. _fig_devicebrowser: -.. figure:: ../api/images/devicebrowser_label.png +.. figure:: ../../api/images/devicebrowser_label.png :width: 100 % :alt: devicebrowser :align: center @@ -62,7 +62,7 @@ the center button key to start the program as shown in :numref:`fig_manualrun`. .. _fig_manualrun: -.. figure:: ../api/images/manualrun_label.png +.. figure:: ../../api/images/manualrun_label.png :width: 100 % :alt: manualrun :align: center diff --git a/doc/api/start_ev3_download.inc b/doc/api/start_ev3/start_ev3_download.inc similarity index 100% rename from doc/api/start_ev3_download.inc rename to doc/api/start_ev3/start_ev3_download.inc diff --git a/doc/api/start_ev3_install.inc b/doc/api/start_ev3/start_ev3_install.inc similarity index 96% rename from doc/api/start_ev3_install.inc rename to doc/api/start_ev3/start_ev3_install.inc index ec8be6f..96b1eab 100644 --- a/doc/api/start_ev3_install.inc +++ b/doc/api/start_ev3/start_ev3_install.inc @@ -33,7 +33,7 @@ in :numref:`fig_overview`. .. _fig_overview: -.. figure:: ../api/images/overview_label.png +.. figure:: ../../api/images/overview_label.png :width: 90 % :alt: overview :align: center @@ -54,7 +54,7 @@ steps below to download, install, and configure this application: .. _fig_store: -.. figure:: ../api/images/store_label.png +.. figure:: ../../api/images/store_label.png :alt: store :align: center @@ -97,7 +97,7 @@ To install the MicroPython tools on your microSD card: .. _fig_etcher: -.. figure:: ../api/images/etcher_label.png +.. figure:: ../../api/images/etcher_label.png :width: 85 % :alt: etcher :align: center diff --git a/doc/api/start_ev3_linux.inc b/doc/api/start_ev3/start_ev3_linux.inc similarity index 98% rename from doc/api/start_ev3_linux.inc rename to doc/api/start_ev3/start_ev3_linux.inc index dd8838b..3d4ca2a 100644 --- a/doc/api/start_ev3_linux.inc +++ b/doc/api/start_ev3/start_ev3_linux.inc @@ -27,7 +27,7 @@ you can enter commands by typing them in and pressing enter. .. _fig_terminal: -.. figure:: ../api/images/terminal_label.png +.. figure:: ../../api/images/terminal_label.png :width: 100 % :alt: files :align: center diff --git a/doc/api/start_ev3_run.inc b/doc/api/start_ev3/start_ev3_run.inc similarity index 91% rename from doc/api/start_ev3_run.inc rename to doc/api/start_ev3/start_ev3_run.inc index 6c6997f..30008d1 100644 --- a/doc/api/start_ev3_run.inc +++ b/doc/api/start_ev3/start_ev3_run.inc @@ -19,7 +19,7 @@ EV3 Brick. .. _fig_projectstructure: -.. figure:: ../api/images/projectstructure_label.png +.. figure:: ../../api/images/projectstructure_label.png :width: 100 % :alt: projectstructure :align: center @@ -38,7 +38,7 @@ choose a location for this program and confirm by clicking *choose folder*. .. _fig_newproject: -.. figure:: ../api/images/newproject_label.png +.. figure:: ../../api/images/newproject_label.png :width: 100 % :alt: newproject :align: center @@ -55,7 +55,7 @@ existing code in place and add your code to it. .. _fig_projectoverview: -.. figure:: ../api/images/projectoverview_label.png +.. figure:: ../../api/images/projectoverview_label.png :width: 100 % :alt: projectoverview :align: center @@ -72,7 +72,7 @@ recently used projects using the *Open Recent* menu option. .. _fig_existingproject: -.. figure:: ../api/images/existingproject_label.png +.. figure:: ../../api/images/existingproject_label.png :width: 75 % :alt: existingproject :align: center @@ -93,7 +93,7 @@ the connection with Visual Studio Code. To do so: .. _fig_connecting: -.. figure:: ../api/images/connecting_label.png +.. figure:: ../../api/images/connecting_label.png :width: 100 % :alt: connecting :align: center @@ -116,7 +116,7 @@ in the output window. .. _fig_running: -.. figure:: ../api/images/running_label.png +.. figure:: ../../api/images/running_label.png :width: 100 % :alt: running :align: center @@ -132,7 +132,7 @@ as shown in :numref:`fig_firstprogram`. .. _fig_firstprogram: -.. figure:: ../api/images/firstprogram_label.png +.. figure:: ../../api/images/firstprogram_label.png :width: 100 % :alt: firstprogram :align: center @@ -142,7 +142,7 @@ as shown in :numref:`fig_firstprogram`. Next, edit *main.py* to make it look like this: .. literalinclude:: - ../../examples/ev3/getting_started/main.py + ../../../examples/ev3/getting_started/main.py This program makes your robot beep, rotate the motor, and beep again with a higher pitched tone. Run the program to make sure that it works as expected. @@ -158,7 +158,7 @@ back up programs stored on it using the device browser as shown in .. _fig_files: -.. figure:: ../api/images/files_label.png +.. figure:: ../../api/images/files_label.png :width: 100 % :alt: files :align: center diff --git a/doc/api/start_ev3_upgrade.inc b/doc/api/start_ev3/start_ev3_upgrade.inc similarity index 97% rename from doc/api/start_ev3_upgrade.inc rename to doc/api/start_ev3/start_ev3_upgrade.inc index 619dbee..f5823f7 100644 --- a/doc/api/start_ev3_upgrade.inc +++ b/doc/api/start_ev3/start_ev3_upgrade.inc @@ -213,7 +213,7 @@ Other internal changes to existing features the speed to the newly given command. This works even if you keep adjusting the speed in a fast loop. - Methods to configure motor settings have changed. You can change settings - using the :doc:`control ` attribute now. The old settings setters + using the ``control`` attribute now. The old settings setters continue to exist in the implementation, but they are no longer documented. - So-called Python *keyword arguments* are now supported. Previously, you could only enter the argument *values*. For example: @@ -235,7 +235,7 @@ Other internal changes to existing features specific type and representation. For example, suppose you measure a color and print the result. If you do ``print(Color.RED)``, you will see the parameter instead of a technical number. -- Sound and image files have moved to a dedicated :doc:`media ` module. +- Sound and image files have moved to a dedicated ``media`` module. Importing them from the old location will continue to work in this release, to make sure existing scripts will still work.