Fix some docs stuff

Signed-off-by: jparisu <[email protected]>
jparisu · Feb 1, 2024 · 2562f04 · 2562f04
1 parent d78ecbd
commit 2562f04
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 27 deletions.
diff --git 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 docs/.spelling/spelling_wordlist.txt
+        sphinx-build -W --keep-going -b spelling docs/ docs/_build/spelling docs/spelling/spelling_wordlist.txt
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,18 +1,27 @@
 
-.. include:: src/titlepage.rst
+.. include:: /rst/titlepage.rst
 
 .. toctree::
-   :caption: Project
+   :caption: Getting Started
    :maxdepth: 2
    :hidden:
 
-   /src/installation
-   /src/tutorial
-   /src/tlnr
+   /rst/installation
+   /rst/tutorial
+   /rst/tldr
 
 .. toctree::
    :caption: Elements
    :maxdepth: 2
    :hidden:
 
-   /src/elements/elements
+   /rst/elements/terrain
+   /rst/elements/measure
+   /rst/elements/generation
+
+.. toctree::
+   :caption: Appendixes
+   :maxdepth: 2
+   :hidden:
+
+   /rst/appendixes/glossary
diff --git a/docs/rst/appendixex/glossary.rst b/docs/rst/appendixex/glossary.rst
@@ -0,0 +1,25 @@
+
+.. _glossary:
+
+########
+Glossary
+########
+
+.. glossary::
+
+    Terrain
+        2D matrix of integers representing the height of a map at each cell.
+
+    Coordinate
+        A tuple of two integers ``(x,y)`` representing a cell in the terrain.
+
+    Path
+        A list of coordinates in the terrain.
+        To be correct, it must start in the origin, end in the destination, and each step must be adjacent to the previous one.
+
+    Cost
+        An integer number related with a path.
+        It represents a measure of the cost of the path in steps and climbs.
+
+    Path Finding Algorithm
+        A function that receives a terrain and returns a valid path.
diff --git a/docs/src/elements/generation.rst → docs/rst/elements/generation.rst b/docs/src/elements/generation.rst → docs/rst/elements/generation.rst
diff --git a/docs/src/elements/measure.rst → docs/rst/elements/measure.rst b/docs/src/elements/measure.rst → docs/rst/elements/measure.rst
diff --git a/docs/src/elements/terrain.rst → docs/rst/elements/terrain.rst b/docs/src/elements/terrain.rst → docs/rst/elements/terrain.rst
diff --git a/docs/src/installation.rst → docs/rst/getting_started/installation.rst b/docs/src/installation.rst → docs/rst/getting_started/installation.rst
@@ -1,4 +1,4 @@
-.. _installation:
+.. _getting_started_installation:
 
 ############
 Installation

diff --git a/docs/src/tldr.rst → docs/rst/getting_started/tldr.rst b/docs/src/tldr.rst → docs/rst/getting_started/tldr.rst
@@ -1,4 +1,4 @@
-.. _tldr:
+.. _getting_started__tldr:
 
 #####
 TL;DR

diff --git a/docs/src/tutorial.rst → docs/rst/getting_started/tutorial.rst b/docs/src/tutorial.rst → docs/rst/getting_started/tutorial.rst
@@ -1,4 +1,4 @@
-.. _tutorial:
+.. _getting_started__tutorial:
 
 ########
 Tutorial

diff --git a/docs/src/titlepage.rst → docs/rst/titlepage.rst b/docs/src/titlepage.rst → docs/rst/titlepage.rst
@@ -34,6 +34,5 @@ Further reading
 
 To start using the library, please check the following links:
 
-- :ref:`installation`
-- :ref:`tutorial`
-- :ref:`elements`
+- :ref:`getting_started_installation`
+- :ref:`getting_started_tutorial`
diff --git a/docs/.spelling/spelling_wordlist.txt → docs/spelling/spelling_wordlist.txt b/docs/.spelling/spelling_wordlist.txt → docs/spelling/spelling_wordlist.txt
diff --git a/docs/src/elements/elements.rst b/docs/src/elements/elements.rst