Update documentation build process and configuration

- Changed pip install path for requirements
- Added pre-build step to execute pre_build.bat
- Updated README instructions for generating docs

.github/workflows/docs.yml

@@ -30,25 +30,14 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          pip install -r docs/requirements.txt
           sudo apt-get update
           sudo apt-get install -y doxygen graphviz default-jre plantuml
 
-      - name: Generate Doxygen documentation
-        run: doxygen docs/Doxyfile
-
-      - name: Generate Sphinx documentation from Doxygen
-        run: python .scripts/link_doxygen_sphinx.py
-
-      - name: Link Examples
-        run: python .scripts/link_examples_sphinx.py
-
-      - name: Run changelog updater
-        run: python .scripts/update_changelog.py
-
-      - name: Append includes to index files
+      - name: Pre-build
         run: |
-          python .scripts/append_includes.py docs/source/reference/migration desc false
+          chmod +x docs/pre_build.bat
+          docs/pre_build.bat
 
       - name: Generate Sphinx documentation
         run: make html

.readthedocs.yml

@@ -0,0 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    pre_build:
+      - chmod +x docs/pre_build.bat
+      - docs/pre_build.bat
+
+sphinx:
+  configuration: docs/source/conf.py
+
+formats:
+  - pdf
+  - epub
+
+python:
+  install:
+    - requirements: docs/requirements.txt

docs/README.md

@@ -22,7 +22,7 @@ The generated HTML files will be available in the `docs/build/html` directory.
 
 ---
 
-There are other documentation files that are generated using some custom scripts, run the `docs.sh` file to generate them:
+There are other documentation files that are generated using some custom scripts, run the `pre_build.bat` file to generate them:
 
 - You will need to have Doxygen installed to generate the Doxygen documentation.
 
@@ -31,11 +31,11 @@ To run the docs.sh file in the terminal, you need to ensure it has execute permi
 1. Give execute permissions to the script:
 
 ```bash
-chmod +x docs.sh
+chmod +x pre_build.bat
 ```
 
 2. Run the script:
 
 ```bash
-./docs.sh
+dosc/pre_build.bat
 ```

library.json

@@ -29,9 +29,7 @@
       "Gemfile",
       "*.toml",
       "docs/",
-      "requirements.txt",
-      "version",
-      "*.sh"
+      "version"
     ]
   }
 }