diff --git a/docs/conf.py b/docs/conf.py index c90e6ed74..f3f45e0d5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,7 +32,9 @@ "sphinx.ext.napoleon", "sphinx.ext.autosummary", "sphinx.ext.intersphinx", - "sphinx_rtd_theme" + "sphinx_rtd_theme", + "sphinx.ext.graphviz", + "sphinx.ext.autosectionlabel", # "sphinxcontrib.bibtex", ] @@ -44,6 +46,9 @@ autosummary_generate = True +# enable numref +numfig = True + # Napoleon settings napoleon_google_docstring = True napoleon_include_init_with_doc = True @@ -95,18 +100,18 @@ html_theme = "sphinx_rtd_theme" # html_static_path = ["_static/custom.css"] -html_theme_options = { - # "logo": "logo.png", - # "logo_name": True, - "badge_branch": "develop", - "codecov_button": True, - "fixed_sidebar": True, - "github_user": "NREL", - "github_repo": "ROSCO toolbox", - "sidebar_width": "375px", - "page_width": "75%", - "show_relbars": True, -} +# html_theme_options = { +# # "logo": "logo.png", +# # "logo_name": True, +# "badge_branch": "develop", +# "codecov_button": True, +# "fixed_sidebar": True, +# "github_user": "NREL", +# "github_repo": "ROSCO toolbox", +# "sidebar_width": "375px", +# "page_width": "75%", +# "show_relbars": True, +# } # 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, diff --git a/docs/figures/ROSCO_toolbox.png b/docs/figures/ROSCO_toolbox.png new file mode 100644 index 000000000..cc48b4024 Binary files /dev/null and b/docs/figures/ROSCO_toolbox.png differ diff --git a/docs/index.rst b/docs/index.rst index 307caa7ee..99e79d067 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,17 @@ ROSCO toolbox documentation NREL's Reference OpenSource Controller (ROSCO) toolbox for wind turbine applications is a toolbox designed to ease controller implementation for the wind turbine researcher. The purpose of these documents is to provide information for the use of the ROSCO related toolchain. +Figure :numref:`fig-RT` shows the general workflow for the ROSCO toolchain. + +.. _fig-RT: +.. figure:: /figures/ROSCO_toolbox.png + :alt: ROSCO_toolbox + :align: center + :width: 400px + + ROSCO toolchain general workflow + + **ROSCO Toolbox** - Generic tuning of NREL's ROSCO controller diff --git a/docs/source/install.rst b/docs/source/install.rst index d7c8f70d8..829ffe2dd 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -1,7 +1,8 @@ -.. _install:: .. toctree:: :max_depth: 3 +.. _install: + Installing the ROSCO tools =========================== Both the ROSCO controller and ROSCO toolbox should be installed if one wishes to leverage the full ROSCO toolchain. Of course, some users may only wish to download and install only the controller or the toolbox.