Adding the version warning banner on every documentation page (#1172)

* New banner in doc

* Update changelog

* gym==0.19.0

* `language = None` to `language = "en"`

docs/conf.py

@@ -84,6 +84,20 @@ def __getattr__(cls, name):
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# Add a string of reStructuredText that will be included at the beginning
+# of every source file that is read. This is a possible place to add
+# substitutions that should be available in every file.
+rst_prolog = """
+.. warning::
+
+ This package is in maintenance mode, please use `Stable-Baselines3
+ (SB3)`_ for an up-to-date version. You can find a `migration guide`_ in
+ SB3 documentation.
+
+.. _Stable-Baselines3 (SB3): https://github.com/DLR-RM/stable-baselines3
+.. _migration guide: https://stable-baselines3.readthedocs.io/en/master/guide/migration.html
+"""
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -98,7 +112,7 @@ def __getattr__(cls, name):
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/index.rst

@@ -10,16 +10,6 @@ Welcome to Stable Baselines docs! - RL Baselines Made Easy
 of Reinforcement Learning (RL) algorithms based on OpenAI `Baselines <https://github.com/openai/baselines>`_.
 
 
-.. warning::
-
- This package is in maintenance mode, please use `Stable-Baselines3
- (SB3)`_ for an up-to-date version. You can find a `migration guide`_ in
- SB3 documentation.
-
-
-.. _Stable-Baselines3 (SB3): https://github.com/DLR-RM/stable-baselines3
-.. _migration guide: https://stable-baselines3.readthedocs.io/en/master/guide/migration.html
-
 Github repository: https://github.com/hill-a/stable-baselines
 
 RL Baselines Zoo (collection of pre-trained agents): https://github.com/araffin/rl-baselines-zoo

docs/misc/changelog.rst

@@ -26,6 +26,10 @@ Deprecations:
 Others:
 ^^^^^^^
 
+Documentation:
+^^^^^^^^^^^^^^
+- Adding the version warning banner on every documentation page (@qgallouedec)
+
 Release 2.10.2 (2021-04-05)
 ---------------------------
 

setup.py

@@ -124,7 +124,7 @@ def find_tf_dependency():
  'stable_baselines': ['py.typed', 'version.txt'],
  },
  install_requires=[
- 'gym[atari,classic_control]>=0.11',
+ 'gym[atari,classic_control]==0.19.0',
  'scipy',
  'joblib',
  'cloudpickle>=0.5.5',