Minor edit to the doc

This commit is contained in:
Antonin Raffin 2020-01-28 10:24:02 +01:00
parent 98037352f5
commit 5c94a225ef
3 changed files with 16 additions and 2 deletions

View file

@ -6,8 +6,11 @@ pytest:
type:
pytype
docs:
doc:
cd docs && make html
spelling:
cd docs && make spelling
clean:
cd docs && make clean

View file

@ -75,6 +75,7 @@ extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
# 'sphinx.ext.intersphinx',
]
if enable_spell_check:
@ -206,3 +207,10 @@ texinfo_documents = [
# -- Extension configuration -------------------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {
# 'python': ('https://docs.python.org/3/', None),
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
# 'torch': ('http://pytorch.org/docs/master/', None),
# }

View file

@ -210,7 +210,10 @@ class BaseRLModel(ABC):
Checked parameters:
- observation_space
- action_space
:return: True if environment seems to be coherent
:param observation_space: (gym.spaces.Space)
:param action_space: (gym.spaces.Space)
:return: (bool) True if environment seems to be coherent
"""
if observation_space != env.observation_space:
return False