Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dependencies (shimmy, sphinx), remove sphinx_autodoc_typehints #1724

Merged
merged 6 commits into from
Oct 24, 2023

Conversation

araffin
Copy link
Member

@araffin araffin commented Oct 23, 2023

Description

When we started SB3, Sphinx didn't properly support type hint and we had to rely on a plugin for that.
But from the beginning, it had to be tweaked (see #10) and caused many issues (because of not properly supporting forward references), the latest one being #1720.

The good news is that Sphinx now natively supports type hints and display them nicely.

I also updated the dependencies as issues are now fixed with the latest rtd theme.

The doc built with this PR: https://stable-baselines3.readthedocs.io/en/chores-update-deps/

NOTE: build of the doc was failing on RTD because new keys in the config are required, RL Zoo and SB3 contrib must be updated too.

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

  • I've read the CONTRIBUTION guide (required)
  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have opened an associated PR on the SB3-Contrib repository (if necessary)
  • I have opened an associated PR on the RL-Zoo3 repository (if necessary)
  • I have reformatted the code using make format (required)
  • I have checked the codestyle using make check-codestyle and make lint (required)
  • I have ensured make pytest and make type both pass. (required)
  • I have checked that the documentation builds using make doc (required)

Note: You can run most of the checks using make commit-checks.

Note: we are using a maximum length of 127 characters per line

Copy link
Collaborator

@ernestum ernestum left a comment

Choose a reason for hiding this comment

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

LGTM. Great idea to simplify the doc build process!

@ernestum ernestum merged commit f56dded into master Oct 24, 2023
4 checks passed
@araffin araffin deleted the chores/update-deps branch November 18, 2024 09:25
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.

2 participants