From c3876ebfd7bec74fc2abc7237297dff66d4287da Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:57:24 -0600 Subject: [PATCH 1/2] Black doc/conf --- doc/conf.py | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 2b65317..1187f22 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -17,9 +17,9 @@ # -- Project information ----------------------------------------------------- -project = 'Pytato' -copyright = '2020, Andreas Klöckner, Matt Wala, Xiaoyu Wei' -author = 'Andreas Klöckner, Matt Wala, Xiaoyu Wei' +project = "Pytato" +copyright = "2020, Andreas Klöckner, Matt Wala, Xiaoyu Wei" +author = "Andreas Klöckner, Matt Wala, Xiaoyu Wei" # -- General configuration --------------------------------------------------- @@ -28,34 +28,34 @@ author = 'Andreas Klöckner, Matt Wala, Xiaoyu Wei' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.mathjax', - 'sphinx_autodoc_typehints', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.mathjax", + "sphinx_autodoc_typehints", ] autoclass_content = "class" # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = "alabaster" html_theme_options = { - "extra_nav_links": { - "🚀 Github": "https://github.com/inducer/pytato", - } - } + "extra_nav_links": { + "🚀 Github": "https://github.com/inducer/pytato", + } +} # 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, @@ -63,15 +63,15 @@ html_theme_options = { html_static_path = [] intersphinx_mapping = { - 'https://docs.python.org/3/': None, - 'https://numpy.org/doc/stable/': None, - 'https://documen.tician.de/boxtree/': None, - 'https://documen.tician.de/meshmode/': None, - 'https://documen.tician.de/modepy/': None, - 'https://documen.tician.de/pyopencl/': None, - 'https://documen.tician.de/pytools/': None, - 'https://documen.tician.de/pymbolic/': None, - 'https://documen.tician.de/loopy/': None, - 'https://documen.tician.de/sumpy/': None, - 'https://documen.tician.de/islpy/': None, - } + "https://docs.python.org/3/": None, + "https://numpy.org/doc/stable/": None, + "https://documen.tician.de/boxtree/": None, + "https://documen.tician.de/meshmode/": None, + "https://documen.tician.de/modepy/": None, + "https://documen.tician.de/pyopencl/": None, + "https://documen.tician.de/pytools/": None, + "https://documen.tician.de/pymbolic/": None, + "https://documen.tician.de/loopy/": None, + "https://documen.tician.de/sumpy/": None, + "https://documen.tician.de/islpy/": None, +} -- GitLab From 0227d628fec8edae4d5940e7a303defc50702041 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:58:46 -0600 Subject: [PATCH 2/2] Switch to furo doc theme --- doc/conf.py | 6 ++---- doc/index.rst | 2 ++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 1187f22..f2efc63 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -32,6 +32,7 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx.ext.mathjax", "sphinx_autodoc_typehints", + "sphinx_copybutton", ] autoclass_content = "class" @@ -49,12 +50,9 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "alabaster" +html_theme = "furo" html_theme_options = { - "extra_nav_links": { - "🚀 Github": "https://github.com/inducer/pytato", - } } # Add any paths that contain custom static files (such as style sheets) here, diff --git a/doc/index.rst b/doc/index.rst index 18dd4da..cbf8e33 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,8 @@ Welcome to Pytato's documentation! reference design misc + 🚀 Github + 💾 Download Releases Indices and tables ================== -- GitLab