From 1a4cbe76f22d81fc3498c52281da57d74c4670bc Mon Sep 17 00:00:00 2001 From: mikee47 Date: Sat, 20 Jul 2019 09:21:31 +0100 Subject: [PATCH] Minor changes --- Sming/Libraries/ArduinoJson5/README.rst | 2 +- docs/Makefile | 2 +- docs/source/arch/esp8266/getting-started/index.rst | 2 +- docs/source/arch/host/host-emulator.rst | 5 ++++- docs/source/getting-started.rst | 2 ++ docs/source/information/upgrade.rst | 2 +- 6 files changed, 10 insertions(+), 5 deletions(-) diff --git a/Sming/Libraries/ArduinoJson5/README.rst b/Sming/Libraries/ArduinoJson5/README.rst index 4b25ba83b9..dc6772037a 100644 --- a/Sming/Libraries/ArduinoJson5/README.rst +++ b/Sming/Libraries/ArduinoJson5/README.rst @@ -1,4 +1,4 @@ ArduinoJson Version 5 ===================== -Provided to support existing applications. New projects should use :library:`ArduinoJson6` +Provided to support existing applications. New projects should use :library:`ArduinoJson6`. diff --git a/docs/Makefile b/docs/Makefile index ea56ed404f..571ca6856c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -119,7 +119,7 @@ References ------------ * :source:`Source Code <$3>` $(if $(findstring $3=,$(SUBMODULE_URLS)), -* This is a submodule: `GIT repository <$(call GetSubmoduleURL,$3)>`__ for details. +* This is a submodule: `GIT repository <$(call GetSubmoduleURL,$3)>`__. ) $(foreach d,$(sort $(COMPONENT_DEPEND_DIRS)), * :doc:`$d/index` Component diff --git a/docs/source/arch/esp8266/getting-started/index.rst b/docs/source/arch/esp8266/getting-started/index.rst index 3dd7e1f483..658a3e49b6 100644 --- a/docs/source/arch/esp8266/getting-started/index.rst +++ b/docs/source/arch/esp8266/getting-started/index.rst @@ -26,7 +26,7 @@ You may need to configure your project to support the specific device being prog Here are a few important ones: * :envvar:`SPI_MODE` Change this if your device fails to program or run -* :envvar:`SPI_SIZE` If using a device with reduced memory you may need to reduce this value. Note also that samples using :component:`spiffs` may not work. +* :envvar:`SPI_SIZE` If using a device with reduced memory you may need to change this value. Note also that samples using :component:`spiffs` may not work. * :envvar:`COM_PORT` If you haven't set this already, it will need to match the port you're using to talk to the Esp8266. * :envvar:`COM_SPEED_ESPTOOL` The default value should work fine but you can usually set a much faster speed. diff --git a/docs/source/arch/host/host-emulator.rst b/docs/source/arch/host/host-emulator.rst index 89bf179f15..85e9c4d4f9 100644 --- a/docs/source/arch/host/host-emulator.rst +++ b/docs/source/arch/host/host-emulator.rst @@ -177,8 +177,11 @@ Make sure to install the 32bit version of the GNU C and C++ compiler, development package and libraries. -.. toctree:: +Further reading +--------------- +.. toctree:: + :titlesonly: /_inc/Sming/Arch/Host/README diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 850bc3a120..1ec14b57df 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -1,6 +1,8 @@ Getting Started =============== +.. highlight:: c++ + Development System Installation ------------------------------- Sming supports multiple architectures. Choose the architecture of your choice to install the needed development software and toolchain(s). diff --git a/docs/source/information/upgrade.rst b/docs/source/information/upgrade.rst index 8d38b7d1a2..26d1760142 100644 --- a/docs/source/information/upgrade.rst +++ b/docs/source/information/upgrade.rst @@ -5,7 +5,7 @@ Upgrading to Sming 4.0 Summary ======= -With the new Sming version 4.0 there will be a lot of backwards +With Sming version 4.0 there are some backwards incompatible changes. This page is provided to help with migrating your applications.