From c6b0e1352fd6fe5be4b178881db9a4f47117dbf1 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 18:47:08 -0600 Subject: [PATCH] Switch to furo doc theme --- doc/conf.py | 80 +++++++++++++++++++++------------------------------ doc/index.rst | 2 ++ 2 files changed, 34 insertions(+), 48 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index f4ffac3..42c1474 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,6 +1,3 @@ -from __future__ import absolute_import -# -*- coding: utf-8 -*- -# # boxtree documentation build configuration file. # # This file is execfile()d with the current directory set to its containing dir. @@ -11,8 +8,6 @@ from __future__ import absolute_import # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -21,34 +16,35 @@ import sys, os # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +#needs_sphinx = "1.0" # Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +# coming with Sphinx (named "sphinx.ext.*") or your custom ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.mathjax', - #'sphinx.ext.viewcode', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.mathjax", + "sphinx_copybutton", + #"sphinx.ext.viewcode", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] autoclass_content = "both" # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +#source_encoding = "utf-8-sig" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'boxtree' -copyright = u'2013, Andreas Kloeckner' +project = u"boxtree" +copyright = u"2013, Andreas Kloeckner" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -56,7 +52,8 @@ copyright = u'2013, Andreas Kloeckner' # # The short X.Y version. ver_dic = {} -exec(compile(open("../boxtree/version.py").read(), "../boxtree/version.py", 'exec'), ver_dic) +exec(compile(open("../boxtree/version.py").read(), "../boxtree/version.py", "exec"), + ver_dic) version = ".".join(str(x) for x in ver_dic["VERSION"]) # The full version, including alpha/beta/rc tags. release = ver_dic["VERSION_TEXT"] @@ -73,7 +70,7 @@ release = ver_dic["VERSION_TEXT"] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ["_build"] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -90,7 +87,7 @@ exclude_patterns = ['_build'] #show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] @@ -98,24 +95,11 @@ pygments_style = 'sphinx' # -- Options for HTML output --------------------------------------------------- -html_theme = "alabaster" +html_theme = "furo" html_theme_options = { - "extra_nav_links": { - "🚀 Github": "https://github.com/inducer/boxtree", - "💾 Download Releases": "https://pypi.python.org/pypi/boxtree", - } } -html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', - 'searchbox.html', - ] -} - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None @@ -137,7 +121,7 @@ html_sidebars = { # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# If not '', a "Last updated on:" timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' @@ -179,22 +163,22 @@ html_static_path = [] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'boxtreedoc' +htmlhelp_basename = "boxtreedoc" # -- Options for LaTeX output -------------------------------------------------- -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# The paper size ("letter" or "a4"). +#latex_paper_size = "letter" -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# The font size ("10pt", "11pt" or "12pt"). +#latex_font_size = "10pt" # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'boxtree.tex', u'boxtree Documentation', - u'Andreas Kloeckner', 'manual'), + ("index", "boxtree.tex", u"boxtree Documentation", + u"Andreas Kloeckner", "manual"), ] # The name of an image file (relative to this directory) to place at the top of @@ -226,15 +210,15 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'boxtree', u'boxtree Documentation', - [u'Andreas Kloeckner'], 1) + ("index", "boxtree", u"boxtree Documentation", + [u"Andreas Kloeckner"], 1) ] # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'http://docs.python.org/': None, - 'https://numpy.org/doc/stable/': None, - 'https://documen.tician.de/pyopencl/': None, - 'https://documen.tician.de/pytential/': None, + "https://docs.python.org/3/": None, + "https://numpy.org/doc/stable/": None, + "https://documen.tician.de/pyopencl/": None, + "https://documen.tician.de/pytential/": None, } diff --git a/doc/index.rst b/doc/index.rst index edff8a3..ac452ba 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -42,6 +42,8 @@ Overview lookup cost misc + 🚀 Github + 💾 Download Releases Indices and tables ------------------ -- GitLab