From d78ecbdf4cd7bf1004d80f623c252778c2a83df3 Mon Sep 17 00:00:00 2001 From: jparisu Date: Wed, 31 Jan 2024 19:22:58 +0100 Subject: [PATCH] Fix spelling Signed-off-by: jparisu --- .github/workflows/docs.yml | 2 +- docs/.spelling/spelling_wordlist.txt | 2 ++ docs/src/installation.rst | 2 +- docs/src/titlepage.rst | 6 +++++- docs/src/tldr.rst | 4 ++-- 5 files changed, 11 insertions(+), 5 deletions(-) create mode 100644 docs/.spelling/spelling_wordlist.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bb3de12..55864d6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -31,4 +31,4 @@ jobs: - name: Check spelling run: | - sphinx-build -W --keep-going -b spelling docs/ docs/_build/spelling + sphinx-build -W --keep-going -b spelling docs/ docs/_build/spelling docs/.spelling/spelling_wordlist.txt diff --git a/docs/.spelling/spelling_wordlist.txt b/docs/.spelling/spelling_wordlist.txt new file mode 100644 index 0000000..6d1d05b --- /dev/null +++ b/docs/.spelling/spelling_wordlist.txt @@ -0,0 +1,2 @@ +IArena +Colab diff --git a/docs/src/installation.rst b/docs/src/installation.rst index 2156fe6..3863f91 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -31,7 +31,7 @@ Install in Windows Anaconda In order to install the package in Windows Anaconda, the steps are the same as for :ref:`installation_googlecolab`. The only detail is that ``git`` may not be installed by default in Anaconda. -From a command prompt, you can install it in a conda environment inside Anaconda: +From a command prompt, you can install it in a ``conda`` environment inside Anaconda: .. code-block:: bash diff --git a/docs/src/titlepage.rst b/docs/src/titlepage.rst index 1426cde..a131e6c 100644 --- a/docs/src/titlepage.rst +++ b/docs/src/titlepage.rst @@ -32,4 +32,8 @@ This library is mainly written in *Python*. Further reading =============== -To start using the library, please check the :ref:`getting_started` section. +To start using the library, please check the following links: + +- :ref:`installation` +- :ref:`tutorial` +- :ref:`elements` diff --git a/docs/src/tldr.rst b/docs/src/tldr.rst index b7040f0..7c6485d 100644 --- a/docs/src/tldr.rst +++ b/docs/src/tldr.rst @@ -12,9 +12,9 @@ This project helps you to generate 2D terrains, that are matrix of integers, wit Over these terrains you have several features: - You can print it in the console -- You can plot it in a matplotlib 2D plot +- You can plot it in a ``matplotlib`` 2D plot - You can plot it in 3D with different angles -- **You can check the total path of a given path** +- **You can check the total length of a given path from origin to destination** - You can even draw the paths in the plots previously mentioned