diff --git a/doc/conf.py b/doc/conf.py index ba7419d45a69acea3e443a8b6244fac2ccb87c7a..84b51663cfd9161822a5bbcc7b2632a713a5354d 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 c86d04ae10533a1d3aaf6b528063932d973b5222..28a910ab08d1a5fbcbeff9cfc260ec346ddc2bb4 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 - <https://github.com/cbclab/MOT>`_ offers a variety of GPU-enabled non-linear optimization algorithms + <https://github.com/cbclab/MOT>`_ 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 <https://github.com/inducer/pyopencl> + 💾 Download Releases <https://pypi.org/project/pyopencl> Note that this guide does not explain OpenCL programming and technology. Please refer to the official `Khronos OpenCL documentation <http://khronos.org/opencl>`_