Added templates for unit testing and sphinx documentation

This commit is contained in:
Brandon Rozek 2020-03-15 14:27:56 -04:00
parent 2e01bc16ea
commit ea62ccf389
18 changed files with 202 additions and 33 deletions

View file

@ -0,0 +1,4 @@
Action Selector
===============
.. automodule:: rltorch.action_selector
:members:

4
docs/source/agents.rst Normal file
View file

@ -0,0 +1,4 @@
Agents
======
.. automodule:: rltorch.agents
:members:

58
docs/source/conf.py Normal file
View file

@ -0,0 +1,58 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
project = 'RLTorch'
copyright = '2020, Brandon Rozek'
author = 'Brandon Rozek'
# The full version, including alpha/beta/rc tags
release = '0.1.0'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
'sphinx.ext.autosummary',
'sphinx.ext.napoleon',
"sphinx.ext.viewcode",
"sphinx.ext.mathjax",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'searchbox.html',
]
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

5
docs/source/env.rst Normal file
View file

@ -0,0 +1,5 @@
Environment Utilities
=====================
.. automodule:: rltorch.env
:members:

15
docs/source/index.rst Normal file
View file

@ -0,0 +1,15 @@
Welcome to RLTorch's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
action_selector
agents
env
memory
mp
network
scheduler
log
seed

4
docs/source/log.rst Normal file
View file

@ -0,0 +1,4 @@
Logging
=======
.. automodule:: rltorch.log
:members:

4
docs/source/memory.rst Normal file
View file

@ -0,0 +1,4 @@
Memory Structures
=================
.. automodule:: rltorch.memory
:members:

4
docs/source/mp.rst Normal file
View file

@ -0,0 +1,4 @@
Multiprocessing
===============
.. automodule:: rltorch.mp
:members:

4
docs/source/network.rst Normal file
View file

@ -0,0 +1,4 @@
Neural Networks
===============
.. automodule:: rltorch.network
:members:

View file

@ -0,0 +1,4 @@
Hyperparameter Scheduling
=========================
.. automodule:: rltorch.scheduler
:members:

4
docs/source/seed.rst Normal file
View file

@ -0,0 +1,4 @@
Seeding
=======
.. automodule:: rltorch.seed
:members: