Fix failing rtd document generation and smuggle some typo corrections. (

#2681) * Fix failing rtd document generation and smuggle some typo corrections. * Applying other changes mentioned in https://blog.readthedocs.com/use-build-os-config/.
SmingHub · Oct 23, 2023 · 68822af · 68822af
1 parent 92b9737
commit 68822af
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,6 +5,12 @@
 # Required
 version: 2
 
+# Required
+build:
+  os: ubuntu-20.04
+  tools: 
+    python: "3.8"
+
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
   - htmlzip
@@ -14,7 +20,6 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
 

diff --git a/docs/source/information/command-handler.rst b/docs/source/information/command-handler.rst
@@ -26,7 +26,7 @@ System commands can be activated using: -
 
 The additional parameter for websocket is used to allow multiple
 connections on one websocket server instance, both with or without
-command proceesing.
+command processing.
 
 When the websocket open request has query parameter ``"command=true"``
 command processing is enabled.

diff --git a/docs/source/information/events.rst b/docs/source/information/events.rst
@@ -75,7 +75,7 @@ such as if a timer expires.
 
 This can be a regular 'C' callback function, which you should use for handling interrupts.
 
-For regular application code, a :cpp:class:`Delegate` provides more flexbility and allows you to create
+For regular application code, a :cpp:class:`Delegate` provides more flexibility and allows you to create
 simpler, cleaner code. See `Delegation <https://en.wikipedia.org/wiki/Delegation_(object-oriented_programming)>`__
 for a bit of background.
 

diff --git a/samples/SDCard/example.output.txt b/samples/SDCard/example.output.txt
@@ -45,7 +45,7 @@ Read: hello has 5 letters
 
 
 
-4. Write speed benchamark:
+4. Write speed benchmark:
 Write 1 kBytes in 1 Bytes increment: 23.17 kB/s
 Write 1 kBytes in 64 Bytes increment: 23.13 kB/s
 Write 1 kBytes in 128 Bytes increment: 23.09 kB/s
@@ -54,4 +54,4 @@ Write 1 kBytes in 1024 Bytes increment: 24.01 kB/s
 Write 4 kBytes in 1024 Bytes increment: 71.36 kB/s
 Write 8 kBytes in 512 Bytes increment: 91.49 kB/s
 Write 8 kBytes in 1024 Bytes increment: 102.11 kB/s
-Write 8 kBytes in 8192 Bytes increment: 96.95 kB/s
+Write 8 kBytes in 8192 Bytes increment: 96.95 kB/s