Skip to content

Commit

Permalink
Fix spelling
Browse files Browse the repository at this point in the history
Signed-off-by: jparisu <[email protected]>
  • Loading branch information
jparisu committed Jan 31, 2024
1 parent 4c512b0 commit d78ecbd
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions docs/.spelling/spelling_wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
IArena
Colab
2 changes: 1 addition & 1 deletion docs/src/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion docs/src/titlepage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
4 changes: 2 additions & 2 deletions docs/src/tldr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down

0 comments on commit d78ecbd

Please sign in to comment.