Add comprehensive documentation with Sphinx and GitHub Pages deployment

[Copilot]

Adds complete documentation infrastructure including NumPy-style docstrings for all classes and kernels, Sphinx documentation system, and automated GitHub Pages deployment.

Documentation Enhancements

• kernels.py: Added comprehensive docstrings to 22+ GPU/CPU kernels and helper functions with full parameter descriptions, return types, and implementation notes
• akima.py: Enhanced all class docstrings (AkimaInterpolant1D, AkimaInterpolant1DMultiDim, AkimaInterpolant1DFlexible) with parameters, attributes, examples, and usage patterns
• All docstrings follow NumPy documentation style for consistency with scientific Python ecosystem

Sphinx Infrastructure

• Complete documentation system in docs/ with:
  • API reference auto-generated from docstrings via autodoc + Napoleon
  • Examples page with code snippets covering basic to advanced usage
  • Tutorial integration via nbsphinx (symlinked from examples/tutorial.ipynb)
  • Read the Docs theme for professional appearance
• Build configuration with intersphinx linking to numpy, numba, and Python docs

Deployment

• GitHub Actions workflow (.github/workflows/docs.yml) for automatic builds on push to main
• Deploys to GitHub Pages with proper artifact handling
• Includes all dependencies (sphinx, sphinx-rtd-theme, nbsphinx, pandoc)

Project Configuration

• Added [project.optional-dependencies] docs extras in pyproject.toml
• Updated .gitignore to exclude build artifacts
• Included docs/README.md with local build instructions

To enable deployment, configure Settings → Pages → Source to "GitHub Actions". Documentation will be available at https://asantini29.github.io/CudAkima/.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• docs.python.org
  • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -M html source build (dns block)
• esm.ubuntu.com
  • Triggering command: /usr/lib/apt/methods/https /usr/lib/apt/methods/https (dns block)
• numba.readthedocs.io
  • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -M html source build (dns block)
• numpy.org
  • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -M html source build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add documentation</issue_title>
<issue_description>Add documentation to the package, both to the class interfaces and the numba functions and kernels. In the documentation page, include the example notebook. add a github workflow to build and deploy the documentation on push.

Modify docstrings and signatures if necessary.</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Add documentation #5

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.