reviews build docs

Author: essicolo

.github/workflows/docs.yml

@@ -23,13 +23,19 @@ jobs:
         pip install .
         pip freeze
         sudo apt-get install pandoc
+    - name: Debug - List contents of docs directory
+      run: ls -R docs
     - name: Build Documentation
       run: |
         cd docs
         make html
         echo "Contents of _build/html directory:"
         ls -R _build/html
       continue-on-error: true
+    - name: Debug - Check Sphinx build output
+      run: |
+        cat docs/_build/html/output.log
+      continue-on-error: true
     - name: Check build output
       run: |
         ls -R docs/_build/html
@@ -41,5 +47,4 @@ jobs:
         path: 'docs/_build/html'
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v2
-      
+      uses: actions/deploy-pages@v2

docs/Makefile

@@ -1,5 +1,4 @@
 # Minimal makefile for Sphinx documentation
-#
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
@@ -12,9 +11,19 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-.PHONY: help Makefile
+.PHONY: help Makefile clean
+
+# Clean target to remove build artifacts
+clean:
+	rm -rf $(BUILDDIR)/*
 
 # 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)
+
+# Custom target for GitHub Actions
+github:
+	@make html
+	@echo "Build completed. Check the contents of $(BUILDDIR)/html"
+	@ls -R $(BUILDDIR)/html

docs/source/conf.py

@@ -16,8 +16,9 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'nbsphinx',
-    'sphinx.ext.viewcode',  # Ajoute des liens vers le code source
-    'sphinx.ext.githubpages',  # Support pour GitHub Pages
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.intersphinx', 
 ]
 
 # Configuration de base
@@ -30,11 +31,11 @@
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # Thème et style
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 html_logo = '_static/logo.png'
 
-# Configuration supplémentaire pour une meilleure documentation
+# Configuration supplémentaire
 autodoc_member_order = 'bysource'
 napoleon_google_docstring = True
 napoleon_numpy_docstring = True
@@ -46,4 +47,10 @@
 napoleon_use_admonition_for_references = False
 napoleon_use_ivar = False
 napoleon_use_param = True
-napoleon_use_rtype = True
+napoleon_use_rtype = True
+
+# Configuration pour intersphinx
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'pandas': ('https://pandas.pydata.org/docs/', None),
+}