From 0a0be9f730be5fa50bcda6f2e73216c96fc064bb Mon Sep 17 00:00:00 2001 From: jparisu Date: Wed, 18 Oct 2023 13:55:59 +0200 Subject: [PATCH] Add read the docs documentation first attempt Signed-off-by: jparisu --- docs/conf.py | 5 +++++ docs/index.rst | 23 +++++++++++++++++++++++ docs/requirements.txt | 9 +++++++++ docs/src/games.rst | 7 +++++++ docs/src/project.rst | 7 +++++++ docs/src/titlepage.rst | 15 +++++++++++++++ readthedocs.yaml | 31 +++++++++++++++++++++++++++++++ 7 files changed, 97 insertions(+) create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/requirements.txt create mode 100644 docs/src/games.rst create mode 100644 docs/src/project.rst create mode 100644 docs/src/titlepage.rst create mode 100644 readthedocs.yaml diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..9084b1b --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,5 @@ +project = 'IArena' +author = 'jparisu' + +extensions = ['sphinx.ext.autodoc'] +html_theme = 'sphinx_rtd_theme' diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..45b5956 --- /dev/null +++ b/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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..ba5a6b4 --- /dev/null +++ b/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 diff --git a/docs/src/games.rst b/docs/src/games.rst new file mode 100644 index 0000000..2962e74 --- /dev/null +++ b/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. diff --git a/docs/src/project.rst b/docs/src/project.rst new file mode 100644 index 0000000..f366173 --- /dev/null +++ b/docs/src/project.rst @@ -0,0 +1,7 @@ +.. _project_overview: + +################ +Project Overview +################ + +Detailed information about the project. diff --git a/docs/src/titlepage.rst b/docs/src/titlepage.rst new file mode 100644 index 0000000..8008a1d --- /dev/null +++ b/docs/src/titlepage.rst @@ -0,0 +1,15 @@ +.. _title: + +.. raw:: html + +

+ IArena Documentation +

+ +*IArena* first documentation release. + +######## +Overview +######## + +Some text. diff --git a/readthedocs.yaml b/readthedocs.yaml new file mode 100644 index 0000000..a5ac61f --- /dev/null +++ b/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