From 7145cf4b2d8cb57211178cf5350c6d867a1842e1 Mon Sep 17 00:00:00 2001 From: Josh Mitchell Date: Wed, 23 Jun 2021 20:35:51 +1000 Subject: [PATCH 1/3] Switch theme to openff-sphinx-theme --- docs/conf.py | 22 +++++++++++++++++++--- docs/environment.yml | 2 +- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c12f85f01..593ee7096 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -49,6 +49,7 @@ 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.extlinks', + 'openff_sphinx_theme', ] autosummary_generate = True @@ -89,13 +90,28 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' - +html_theme = "openff_sphinx_theme" +html_sidebars = {"**": ["globaltoc.html", "localtoc.html", "searchbox.html"]} # 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. # -# html_theme_options = {} +html_theme_options = { + # Repository integration + # Set the repo url for the link to appear + "repo_url": "https://github.com/openforcefield/openff-interchange", + # The name of the repo. If must be set if repo_url is set + "repo_name": "openff-interchange", + # Must be one of github, gitlab or bitbucket + "repo_type": "github", + # Colour for sidebar captions and other accents. One of + # openff-blue, openff-toolkit-blue, openff-dataset-yellow, + # openff-evaluator-orange, aquamarine, lilac, amaranth, grape, + # violet, pink, pale-green, green, crimson, eggplant, turquoise, + # or a tuple of three ints in the range [0, 255] corresponding to + # a position in RGB space. + "color_accent": "pale-green", +} # 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/environment.yml b/docs/environment.yml index 24de841c7..0da205ef6 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -14,4 +14,4 @@ dependencies: # readthedocs dependencies - myst-parser - numpydoc - - sphinx_rtd_theme + - git+https://github.com/openforcefield/openff-sphinx-theme.git@main From d5b44d6dc366fbd99002f19e291b0ac149edac55 Mon Sep 17 00:00:00 2001 From: Josh Mitchell Date: Wed, 23 Jun 2021 20:40:30 +1000 Subject: [PATCH 2/3] typo --- docs/environment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/environment.yml b/docs/environment.yml index 0da205ef6..c6fa013e4 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -14,4 +14,5 @@ dependencies: # readthedocs dependencies - myst-parser - numpydoc + - pip: - git+https://github.com/openforcefield/openff-sphinx-theme.git@main From 72d4f45343569eade2fee4b86b127a5a7bd1f357 Mon Sep 17 00:00:00 2001 From: "Josh A. Mitchell" Date: Tue, 13 Jul 2021 18:30:11 +1000 Subject: [PATCH 3/3] Update conf.py --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 593ee7096..db66b54e6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,6 +111,9 @@ # or a tuple of three ints in the range [0, 255] corresponding to # a position in RGB space. "color_accent": "pale-green", + # Content Minification for deployment, prettification for debugging + "html_minify": True, + "css_minify": True, } # Add any paths that contain custom static files (such as style sheets) here,