diff --git a/.gitignore b/.gitignore index b464566b..0d27eb1c 100644 --- a/.gitignore +++ b/.gitignore @@ -83,6 +83,7 @@ target/ # Jupyter Notebook .ipynb_checkpoints PPO_UC2/ +docs/_static/notebooks/html/*.html # IPython profile_default/ @@ -152,6 +153,7 @@ docs/source/primaite-dependencies.rst src/primaite/outputs/ simulation_output/ sessions/ +PrimAITE-PPO-example-agent.zip # benchmark session outputs benchmark/output diff --git a/docs/conf.py b/docs/conf.py index a666e460..33e192aa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,6 +66,33 @@ html_theme_options = {"globaltoc_collapse": True, "globaltoc_maxdepth": 2} html_copy_source = False +def get_notebook_links() -> str: + """ + Returns a string which will be added to the RST. + + Allows for dynamic addition of notebooks to the documentation. + """ + notebooks = os.listdir("_static/notebooks/html") + + links = [] + links.append("