docs: add read the docs and organize the documents (#1357)

### **Motivation**  
The previous documentation structure was not optimized for navigation
and usability. To improve clarity and ease of use, I restructured the
`toctree` and integrated a **Read the Docs** interface. This will help
users find information faster and better understand the documentation
structure.

---

### **Description**  
- Refactored the `toctree` to create a more intuitive hierarchy for
documentation.
- Organized Markdown (`.md`) files into logical sections with
collapsible folders.
- Configured Read the Docs (`conf.py`, `myst_parser`, etc.) to support
Markdown properly.
- Improved the sidebar navigation by grouping related topics under
relevant categories.

These changes enhance the documentation experience for both new and
experienced users.

---

### **Testing**  
- Built the documentation locally using Sphinx to verify that the
`toctree` renders correctly.
- Ensured all links and cross-references function properly.  
- Verified that Markdown files are correctly parsed and displayed.  

---

### **Impact**  
- **Documentation**: The structure is now clearer, making it easier for
users to navigate.
- **Configuration**: Added/modified `conf.py` settings to support
Markdown (`myst_parser`).
- **Performance**: No impact on performance, as this only affects
documentation.
- **Dependencies**: If `myst-parser` was not previously installed, it
needs to be added (`pip install myst-parser`).
- **Behavior**: No functional changes to the codebase, only improvements
in documentation accessibility.

---

### **Additional Information**  
- If necessary, update any links in the project that point to the old
documentation structure.
- Ensure the Read the Docs build process is running smoothly with these
changes.
- This PR does not modify any production code but significantly improves
documentation usability.

# Checklist

- [x] My code adheres to the coding and style guidelines of the project.
- [x] I have performed a self-review of my code.
- [x] I have commented my code, particularly in hard-to-understand
areas.
- [x] I have made corresponding changes to the documentation.
- [x] I have thoroughly tested my modifications and added tests when
necessary.
- [x] Tests pass locally and in the CI.
- [x] I have assessed the performance impact of my modifications.

.docs/README.md

@@ -4,26 +4,30 @@ Docs for ArmoniK
 
 ## Installation
 
-> Be aware to be in the .docs folder
+> Be aware to be at the root of the repository
 
 ```bash
-pnpm install
+python -m venv .venv-doc
 ```
 
-> If you don't have pnpm installed, you can install it with the following command: `npm install -g pnpm`
+Then activate the virtual environment:
 
-## Usage
+```bash
+source .venv-doc/bin/activate
+```
 
-To run the docs locally, run the following command:
+And install dependencies:
 
 ```bash
-pnpm run dev
+pip install -r .docs/requirements.txt
 ```
 
-To build the docs, run the following command:
+## Usage
+
+To build the docs locally, run the following command:
 
 ```bash
-pnpm run generate
+sphinx-build -M html .docs build
 ```
 
-For more information, check out the [armonik-docs-theme documentation](https://aneoconsulting.github.io/armonik-docs-theme).
+Outputs can be found in `build/html/index.html`.

.docs/conf.py

@@ -0,0 +1,50 @@
+# 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 = "ArmoniK"
+copyright = "2021-%Y, ANEO"
+author = "ANEO"
+release = "main"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["myst_parser", 'sphinxcontrib.mermaid']
+
+templates_path = ["_templates"]
+exclude_patterns = ["requirements.txt", "README.md"]
+suppress_warnings = ["myst.header", "misc.highlighting_failure"]
+
+# -- 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_search = True
+
+
+# -- Options for source files ------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-source-files
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
+
+# -- Options MyST Parser ------------------------------------------------
+myst_fence_as_directive = ["mermaid"]
+myst_heading_anchors = 3
+
+# -- Options to show "Edit on GitHub" button ---------------------------------
+html_context = {
+    "display_github": True, # Integrate GitHub
+    "github_user": "aneoconsulting", # Username
+    "github_repo": "ArmoniK", # Repo name
+    "github_version": "main", # Version
+    "conf_py_path": "/.docs/", # Path in the checkout to the docs root
+}