Add doxygen documentation to Python bindings (#310)

* Init adding docs to pybinded functions

* Ignore docs folder

* Add docstrings

* Working!

* Replace pylint with ruff

* Copilot suggestion

Author: Grufoony

.github/workflows/gh-pages.yml

@@ -34,6 +34,6 @@ jobs:
         
       - name: Commit and Push
         run: |
-          git add ./docs
+          git add ./docs -f
           git commit -m "Auto-deploy documentation"
           git push --force

.github/workflows/pylint.yml .github/workflows/ruff.yml.github/workflows/pylint.yml renamed to .github/workflows/ruff.yml

@@ -1,4 +1,4 @@
-name: Pylint
+name: Ruff checking
 
 on:
   push:
@@ -11,15 +11,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-    - name: Set up Python 3.10
+    - name: Set up Python 3.12
       uses: actions/setup-python@v3
       with:
-        python-version: "3.10"
+        python-version: "3.12"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pylint
+        pip install ruff
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Analysing the code with pylint
+    - name: Analysing the code with ruff
       run: |
-        pylint $(git ls-files '*.py')
+        ruff format --check $(git ls-files '*.py')
+        ruff check $(git ls-files '*.py')

.gitignore

@@ -3,6 +3,7 @@
 
 # Shared libraries
 *.so
+*.pyi
 
 # CMake build directories
 *build
@@ -20,6 +21,7 @@
 # cache files
 *cache
 *.adj
+.docstrings.hpp
 
 temp*
 
@@ -35,6 +37,8 @@ utils/*.png
 # Utils generated folders
 __pycache__
 images
+xml
+docs
 examples/debug
 examples/release
 

CMakeLists.txt

@@ -56,7 +56,7 @@ if(BUILD_PYTHON_BINDINGS)
     # Get pybind11
     FetchContent_Declare(pybind11
         GIT_REPOSITORY https://github.com/pybind/pybind11.git
-        GIT_TAG v2.13.6
+        GIT_TAG v3.0.1
     )
     FetchContent_GetProperties(pybind11)
     if(NOT pybind11_POPULATED)

Doxyfile

@@ -2214,7 +2214,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = NO
+GENERATE_XML           = YES
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include LICENSE
+include requirements.txt
+include CMakeLists.txt
+include Doxyfile
+recursive-include src *
+recursive-include dsf *.pyi
+global-exclude *.pyc
+global-exclude __pycache__
+global-exclude *.so

pyproject.toml

@@ -1,3 +1,3 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=61.0", "wheel", "pybind11-stubgen"]
 build-backend = "setuptools.build_meta"