Add read the docs documentation first attempt

Signed-off-by: jparisu <[email protected]>

docs/conf.py

@@ -0,0 +1,5 @@
+project = 'IArena'
+author = 'jparisu'
+
+extensions = ['sphinx.ext.autodoc']
+html_theme = 'sphinx_rtd_theme'

docs/index.rst

@@ -0,0 +1,23 @@
+
+.. toctree::
+   :caption: Introduction
+   :maxdepth: 2
+   :hidden:
+
+   /src/titlepage
+
+
+.. toctree::
+   :caption: Project
+   :maxdepth: 2
+   :hidden:
+
+   /src/project
+
+
+.. toctree::
+   :caption: Games
+   :maxdepth: 2
+   :hidden:
+
+   /src/games

docs/requirements.txt

@@ -0,0 +1,9 @@
+doc8==0.10.1
+docutils==0.16.0
+GitPython==3.1.32
+setuptools==65.5.1
+sphinx_rtd_theme==0.5.2
+sphinx-tabs==3.2.0
+sphinx==4.3.1
+sphinxcontrib-imagehelper==1.1.1
+sphinxcontrib.spelling==7.2.1

docs/src/games.rst

@@ -0,0 +1,7 @@
+.. _games:
+
+#####
+Games
+#####
+
+In this page will be displayed the different games available in the platform along with their description, characteristics and tutorials.

docs/src/project.rst

@@ -0,0 +1,7 @@
+.. _project_overview:
+
+################
+Project Overview
+################
+
+Detailed information about the project.

docs/src/titlepage.rst

@@ -0,0 +1,15 @@
+.. _title:
+
+.. raw:: html
+
+  <h1>
+    IArena Documentation
+  </h1>
+
+*IArena* first documentation release.
+
+########
+Overview
+########
+
+Some text.

readthedocs.yaml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt