diff --git a/docs/conf.py b/docs/conf.py index 0352081..4e4a2de 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,6 @@ import os import sys from unittest.mock import MagicMock -import torchy_baselines # source code directory, relative to this file, for sphinx-autobuild sys.path.insert(0, os.path.abspath('..')) @@ -44,6 +43,10 @@ MOCK_MODULES = ['joblib', 'scipy', 'scipy.signal', 'gym.wrappers', 'gym.wrappers.monitoring', 'zmq'] sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES) + +import torchy_baselines + + # -- Project information ----------------------------------------------------- project = 'Torchy Baselines' @@ -55,6 +58,7 @@ version = 'master (' + torchy_baselines.__version__ + ' )' # The full version, including alpha/beta/rc tags release = torchy_baselines.__version__ + # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -99,6 +103,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' + # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -117,7 +122,6 @@ html_logo = '_static/img/logo.png' def setup(app): app.add_stylesheet("css/baselines_theme.css") - # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. @@ -145,6 +149,7 @@ html_static_path = ['_static'] # Output file base name for HTML help builder. htmlhelp_basename = 'TorchyBaselinesdoc' + # -- Options for LaTeX output ------------------------------------------------ latex_elements = { @@ -173,6 +178,7 @@ latex_documents = [ 'Torchy Baselines Contributors', 'manual'), ] + # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples @@ -182,6 +188,7 @@ man_pages = [ [author], 1) ] + # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples