From 9ab1b5825bac361b616460781ba5ecde01b6eebe Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:55:18 -0600 Subject: [PATCH] Switch to furo doc theme --- doc/conf.py | 18 +++--------------- doc/index.rst | 4 +++- 2 files changed, 6 insertions(+), 16 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index ba7419d4..84b51663 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -25,6 +25,7 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx.ext.autodoc", "sphinx.ext.doctest", + "sphinx_copybutton", ] # Add any paths that contain templates here, relative to this directory. @@ -85,23 +86,10 @@ pygments_style = "sphinx" # Options for HTML output # ----------------------- -html_theme = "alabaster" +html_theme = "furo" html_theme_options = { - "extra_nav_links": { - "🚀 Github": "https://github.com/inducer/pyopencl", - "💾 Download Releases": "https://pypi.python.org/pypi/pyopencl", - } -} - -html_sidebars = { - "**": [ - "about.html", - "navigation.html", - "relations.html", - "searchbox.html", - ] -} + } # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths diff --git a/doc/index.rst b/doc/index.rst index c86d04ae..28a910ab 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -88,7 +88,7 @@ Software that works with or enhances PyOpenCL :class:`pyopencl.array.Array` instances. * Robbert Harms and Alard Roebroeck's `MOT - `_ offers a variety of GPU-enabled non-linear optimization algorithms + `_ offers a variety of GPU-enabled non-linear optimization algorithms and MCMC sampling routines for parallel optimization and sampling of multiple problems. If you know of a piece of software you feel that should be on this list, please @@ -113,6 +113,8 @@ Contents howto tools misc + 🚀 Github + 💾 Download Releases Note that this guide does not explain OpenCL programming and technology. Please refer to the official `Khronos OpenCL documentation `_ -- GitLab