Skip to content

refactor(docs): change theme and consolidate dependencies#161

Merged
henry2004y merged 2 commits into
mainfrom
fix-docs-dependencies-and-cleanup-v2
Nov 16, 2025
Merged

refactor(docs): change theme and consolidate dependencies#161
henry2004y merged 2 commits into
mainfrom
fix-docs-dependencies-and-cleanup-v2

Conversation

@henry2004y

Copy link
Copy Markdown
Owner

This commit addresses several issues with the documentation and repository structure:

  • Switches the Sphinx theme to pydata-sphinx-theme.
  • Moves all documentation dependencies from docs/requirements.txt into a [project.optional-dependencies.docs] section in pyproject.toml for centralized dependency management.
  • Deletes the now-redundant docs/requirements.txt.

This commit addresses several issues with the documentation and repository structure:

- Switches the Sphinx theme to `pydata-sphinx-theme`.
- Moves all documentation dependencies from `docs/requirements.txt` into a `[project.optional-dependencies.docs]` section in `pyproject.toml` for centralized dependency management.
- Deletes the now-redundant `docs/requirements.txt`.
- Removes generated trajectory files (`.h5`, `.parquet`, `.csv`) that were previously committed in the `docs/` directory.
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @henry2004y, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the project's documentation setup by updating the Sphinx theme for a more modern appearance and consolidating all documentation-related dependencies into pyproject.toml. This change streamlines dependency management, removes a redundant requirements file, and ensures a consistent and maintainable build process for the project's documentation.

Highlights

  • Documentation Theme Update: The Sphinx documentation theme has been switched from sphinx_rtd_theme to pydata_sphinx_theme in docs/conf.py to modernize the look and feel of the documentation.
  • Centralized Dependency Management: Documentation-specific dependencies, previously listed in docs/requirements.txt, have been moved into a new [project.optional-dependencies.docs] section within pyproject.toml. This centralizes dependency management and aligns with modern Python packaging practices.
  • Dependency File Removal: The docs/requirements.txt file has been removed as its contents are now managed through pyproject.toml.
  • Development Environment Update: The dev optional dependency group in pyproject.toml has been updated to include the new docs group, ensuring that all necessary documentation build tools are available in the development environment.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@codecov

codecov Bot commented Nov 16, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.31%. Comparing base (4c8d077) to head (307873a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #161   +/-   ##
=======================================
  Coverage   68.31%   68.31%           
=======================================
  Files          25       25           
  Lines        4191     4191           
=======================================
  Hits         2863     2863           
  Misses       1328     1328           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request is a good refactoring that consolidates documentation dependencies into pyproject.toml and updates the Sphinx theme. This centralizes configuration and simplifies the project structure. My review includes one suggestion to add version pinning for the new documentation dependencies to ensure reproducible builds and prevent future breakages. Overall, a solid improvement.

Comment thread pyproject.toml
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@henry2004y henry2004y merged commit 688b18a into main Nov 16, 2025
3 checks passed
@henry2004y henry2004y deleted the fix-docs-dependencies-and-cleanup-v2 branch November 16, 2025 01:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant