Staging

[Hackshaven]

This pull request improves the documentation build and appearance by updating the Sphinx configuration and workflow. The main changes include adding support for the sphinx_rtd_theme, enabling autosummary for cleaner API docs, and updating the documentation workflow to ensure all dependencies are installed. These updates will result in a more modern look for the docs and better API reference pages.

Documentation build and theme improvements:

• Updated .github/workflows/docs-pages.yaml to install sphinx_rtd_theme and the local package before building docs, ensuring all dependencies are available for the documentation build.
• Modified docs/source/conf.py to use sphinx_rtd_theme if available, falling back to alabaster otherwise, and added advanced theme options for navigation.
• Enabled autosummary and configured Sphinx extensions for improved API documentation, including autosummary_generate and autosummary_imported_members options. [1] [2]

API documentation structure:

• Updated docs/source/index.rst to include a new toctree for package-level API documentation, improving discoverability of modules and subpackages.

General improvements:

• Added a missing import (importlib.util) in docs/source/conf.py for dynamic theme selection.

[Copilot]

Pull Request Overview

This pull request improves the documentation build and appearance by updating Sphinx configuration to use the ReadTheDocs theme and enhancing API documentation structure. The changes include adding theme selection logic, enabling autosummary extensions, and updating the GitHub Actions workflow to install necessary dependencies.

• Updated Sphinx configuration to support sphinx_rtd_theme with fallback to alabaster
• Added autosummary extension and theme options for better navigation
• Enhanced documentation workflow to install theme dependencies and local package

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File	Description
pyproject.toml	Version bump from 0.1.17 to 0.1.18
docs/source/index.rst	Added new toctree section for package-level API documentation
docs/source/conf.py	Added theme selection logic, autosummary extension, and theme configuration
.github/workflows/docs-pages.yaml	Updated to install sphinx_rtd_theme and local package dependencies

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}