Add package to install by tom-doerr · Pull Request #378 · DLR-RM/stable-baselines3 (original) (raw)

Description

This adds a package to install to the list of packages needed for building the documentation.

Motivation and Context

If the added package is not installed, the following error is thrown:

(venv) ➜  docs git:(fix_extra_install_command) ✗ make html
Running Sphinx v3.5.3

Extension error:
Could not import extension sphinx_autodoc_typehints (exception: No module named 'sphinx_autodoc_typehints')
make: *** [Makefile:20: html] Error 2
(venv) ➜  docs git:(fix_extra_install_command) ✗ pip --version
pip 20.0.2 from /home/tom/git/stable-baselines3/venv/lib/python3.8/site-packages/pip (python 3.8)
(venv) ➜  docs git:(fix_extra_install_command) ✗ make html
Running Sphinx v3.5.3

Extension error:
Could not import extension sphinx_autodoc_typehints (exception: No module named 'sphinx_autodoc_typehints')
make: *** [Makefile:20: html] Error 2

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 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