feat(docs): Adding documentation generation

.github/workflows/doc.yml

@@ -0,0 +1,45 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Documentation production
+
+on:
+  push:
+    branches: 
+      - "**" 
+      # Will need to be restricted to main branch in the future
+  pull_request:
+    branches: 
+      - "**"
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest sphinx sphinxawesome-theme
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    
+    - name: Build html documentation
+      run: |
+        cd ./docs && make html
+
+    - name: Deploy documentation
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs

App/travel_resolver/libs/sample/greeter.py

@@ -1,7 +1,19 @@
 class GreeterHelper():
     def __init__(self):
+        """
+            Initialize base private attributes with sample values.
+        """
         self._base_message = "Hello ! "
 
-    def Greet(self, message):
+    def Greet(self, message: str):
+        """
+            Print greeting message in the terminal.
+
+            Args:
+                message (str): Message that will be included in greeting.
+
+            Returns:
+                (str): The full printed message.
+        """
         print(self._base_message + message)
         return "Hello ! " + message

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,34 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+from pathlib import Path
+import sys
+html_theme = 'sphinxawesome_theme'
+
+project = 'TravelOrderResolver'
+copyright = '2024, Azar, Chapuis, Thanh, Goupil, Duquesnoy'
+author = 'Azar, Chapuis, Thanh, Goupil, Duquesnoy'
+
+sys.path.insert(0, (Path(__file__).parents[1].resolve() / 'App').as_posix())
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary'
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/index.rst

@@ -0,0 +1,19 @@
+.. TravelOrderResolver documentation master file, created by
+   sphinx-quickstart on Tue Sep  3 14:51:06 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+TravelOrderResolver documentation
+=================================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 5
+   :caption: Contents:
+
+.. toctree::
+   travel_resolver

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/travel_resolver.libs.ner.rst

@@ -0,0 +1,7 @@
+travel\_resolver.libs.ner package
+=================================
+
+.. automodule:: travel_resolver.libs.ner
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.libs.pathfinder.rst

@@ -0,0 +1,7 @@
+travel\_resolver.libs.pathfinder package
+========================================
+
+.. automodule:: travel_resolver.libs.pathfinder
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.libs.rst

@@ -0,0 +1,15 @@
+travel\_resolver.libs package
+=============================
+
+.. toctree::
+   :maxdepth: 4
+
+   travel_resolver.libs.ner
+   travel_resolver.libs.pathfinder
+   travel_resolver.libs.sample
+   travel_resolver.libs.speech2text
+
+.. automodule:: travel_resolver.libs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.libs.sample.greeter.rst

@@ -0,0 +1,7 @@
+travel\_resolver.libs.sample.greeter module
+===========================================
+
+.. automodule:: travel_resolver.libs.sample.greeter
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.libs.sample.rst

@@ -0,0 +1,12 @@
+travel\_resolver.libs.sample package
+====================================
+
+.. toctree::
+   :maxdepth: 4
+
+   travel_resolver.libs.sample.greeter
+
+.. automodule:: travel_resolver.libs.sample
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.libs.speech2text.rst

@@ -0,0 +1,7 @@
+travel\_resolver.libs.speech2text package
+=========================================
+
+.. automodule:: travel_resolver.libs.speech2text
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.rst

@@ -0,0 +1,13 @@
+travel\_resolver package
+========================
+
+.. toctree::
+   :maxdepth: 4
+
+   travel_resolver.libs
+   travel_resolver.tests
+
+.. automodule:: travel_resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.tests.rst

@@ -0,0 +1,12 @@
+travel\_resolver.tests package
+==============================
+
+.. toctree::
+   :maxdepth: 4
+
+   travel_resolver.tests.sample_test
+
+.. automodule:: travel_resolver.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/travel_resolver.tests.sample_test.rst

@@ -0,0 +1,7 @@
+travel\_resolver.tests.sample\_test module
+==========================================
+
+.. automodule:: travel_resolver.tests.sample_test
+   :members:
+   :undoc-members:
+   :show-inheritance: