Docs: Initialisation de la documentation du projet (#20)

- Utilisation de la bibliothèque Sphinx
- Ajout du dossier 'docs' contenant toute la documentation du projet
- Ajout des fichiers .rst pour ajouter une page d'accueil ainsi que les modules dans la documentation
- Modification des docstrings des classes dans le dossier donnees ( modification mot-clé Attributes en Args) afin d'éviter des erreurs de génération avec Sphinx

Author: AnthonyGuillauma

.gitignore

@@ -14,4 +14,7 @@ __pycache__/
 
 # Fichiers propres à Coverage
 .coverage
-htmlcov/
+htmlcov/
+
+# Fichiers de la documentation sphinx
+docs/build/

app/donnees/client_informations.py

@@ -14,7 +14,7 @@ class ClientInformations:
     Cette classe regroupe les données extraites d'une entrée de log,
     qui concernent le client ayant effectué la requête au serveur Apache.
 
-    Attributes:
+    Args:
         adresse_ip (str): L'adresse IP du client.
         identifiant_rfc (Optional[str]): L'identifiant RFC du client. 
             Peut être None si non fournie.

app/donnees/reponse_informations.py

@@ -15,7 +15,7 @@ class ReponseInformations:
     qui concernent les informations techniques sur la réponse émise par
     le serveur Apache au client.
 
-    Attributes:
+    Args:
         code_statut_http (int): Le code de statut HTTP.
         taille_octets (Optional[int]): La taille de la réponse en octets.
             Peut être None si non fournie.

app/donnees/requete_informations.py

@@ -15,7 +15,7 @@ class RequeteInformations:
     qui concernent les informations techniques sur la requête émise au
     serveur Apache.
 
-    Attributes:
+    Args:
         horodatage (datetime): L'horodatage de la requête.
         methode_http (Optional[str]): La méthode HTTP utilisée.
             Peut être None si non fournie.

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     = source
+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/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+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/source/_static/documentation.css

@@ -0,0 +1,4 @@
+/* Étendre le contenu principal sur toute la largeur */
+.wy-nav-content {
+    max-width: 100%;
+}

docs/source/conf.py

@@ -0,0 +1,39 @@
+import os
+import sys
+
+# 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
+
+project = 'LogBuster'
+copyright = '2025, Anthony GUILLAUMA'
+author = 'Anthony GUILLAUMA'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+language = 'fr'
+
+# Ajout du chemin vers les modules
+sys.path.insert(0, os.path.abspath('../../app'))
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_css_files = ["documentation.css"]
+html_theme_options = {
+    "collapse_navigation": False,   # Pour éviter la fermeture automatique
+    "sticky_navigation": True,  # Pour rendre le menu toujours visible
+    "titles_only": False    # Pour éviter de masquer les sous-sections
+}

docs/source/index.rst

@@ -0,0 +1,22 @@
+.. Documentation de LogBuster
+
+Bienvenue dans la documentation de LogBuster
+============================================
+
+LogBuster est un outil puissant pour analyser les fichiers de log Apache. 
+Il vous permet de :
+
+- Extraire des statistiques clés.
+- Exporter les données en JSON.
+- Gérer les erreurs de format avec précision.
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contenu
+   :numbered:
+
+   modules/index_modules.rst
+
+---
+
+© 2025 - Projet LogBuster

docs/source/modules/cli/index_cli.rst

@@ -0,0 +1,7 @@
+CLI
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   parseur_arguments_cli.rst