From d46d114be0e3018773a275b9bf186b60f4f122b9 Mon Sep 17 00:00:00 2001 From: Vladimir Fokow <57260995+VladimirFokow@users.noreply.github.com> Date: Tue, 9 Jan 2024 14:53:01 +0100 Subject: [PATCH 1/2] fix typo: usefull -> useful --- docs/build/html/build-the-docs.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/html/build-the-docs.html b/docs/build/html/build-the-docs.html index 2779226..b3e1a84 100644 --- a/docs/build/html/build-the-docs.html +++ b/docs/build/html/build-the-docs.html @@ -210,7 +210,7 @@

Generating documentation from docstringssimpleble.rst and modules.rst in our Sphinx source root directory. The modules.rst file is usefull when more than one modules (.py files) are included in our Python source directory, but since we only have one module and to keep thing simple, we can ignore it for the purposes of this tutorial. Let’s have a look at the contents of simpleble.rst:

+

The above command generates two files: simpleble.rst and modules.rst in our Sphinx source root directory. The modules.rst file is useful when more than one modules (.py files) are included in our Python source directory, but since we only have one module and to keep thing simple, we can ignore it for the purposes of this tutorial. Let’s have a look at the contents of simpleble.rst:

simpleble module
 ================
 

From 8f1fd94a9c27d30cb700d0b9a37302bd0059edf3 Mon Sep 17 00:00:00 2001
From: Vladimir Fokow <57260995+VladimirFokow@users.noreply.github.com>
Date: Tue, 9 Jan 2024 14:59:17 +0100
Subject: [PATCH 2/2] fix typo: usefull -> useful (in the correct file)

---
 docs/source/build-the-docs.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/source/build-the-docs.rst b/docs/source/build-the-docs.rst
index 9d73f88..a42c73b 100644
--- a/docs/source/build-the-docs.rst
+++ b/docs/source/build-the-docs.rst
@@ -54,7 +54,7 @@ Now let's see how we can auto-generate documentation from the docstrings in our
     Creating file ./source/simpleble.rst.
     Creating file ./source/modules.rst.
 
-The above command generates two files: ``simpleble.rst`` and ``modules.rst`` in our `Sphinx source root` directory. The ``modules.rst`` file is usefull when more than one modules (``.py`` files) are included in our Python source directory, but since we only have one module and to keep thing simple, we can ignore it for the purposes of this tutorial. Let's have a look at the contents of ``simpleble.rst``:
+The above command generates two files: ``simpleble.rst`` and ``modules.rst`` in our `Sphinx source root` directory. The ``modules.rst`` file is useful when more than one modules (``.py`` files) are included in our Python source directory, but since we only have one module and to keep thing simple, we can ignore it for the purposes of this tutorial. Let's have a look at the contents of ``simpleble.rst``:
 
 .. code-block:: RST