This pull request aims to fix the following warning thrown during the Sphinx documentation (pipenv run build) build process:
WARNING: autodoc: failed to import module 'path' from module 'gym_md.envs.agent';
the following exception was raised: No module named 'gym_md.envs.agent.path'
Original build output, before fix:
Running Sphinx v4.2.0
WARNING: html_static_path entry '_static' does not exist
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] gym_md.envs.agent
/home/***/***/gym-md/gym_md/envs/agent/agent.py:docstring of gym_md.envs.agent.agent.Agent.select_action:8: WARNING: Inline strong start-string without end-string.
WARNING: autodoc: failed to import module 'path' from module 'gym_md.envs.agent'; the following exception was raised:
No module named 'gym_md.envs.agent.path'
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/***/***/gym-md/source/modules.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] index
generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 4 warnings.
The HTML pages are in build.
Original build output, after fix:
Running Sphinx v4.2.0
WARNING: html_static_path entry '_static' does not exist
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] gym_md.envs.agent
/home/***/***/gym-md/gym_md/envs/agent/agent.py:docstring of gym_md.envs.agent.agent.Agent.select_action:8: WARNING: Inline strong start-string without end-string.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/***/***/gym-md/source/modules.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] index
generating indices... genindex py-modindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.
The HTML pages are in build
Overview
This pull request aims to fix the following warning thrown during the Sphinx documentation (
pipenv run build) build process:Original build output, before fix:
Original build output, after fix: