refactor(docs): change theme and consolidate dependencies#161
Conversation
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.
Summary of ChangesHello @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 Highlights
Using Gemini Code AssistThe 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
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 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
|
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
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.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This commit addresses several issues with the documentation and repository structure:
pydata-sphinx-theme.docs/requirements.txtinto a[project.optional-dependencies.docs]section inpyproject.tomlfor centralized dependency management.docs/requirements.txt.