From 626b5e4c3bd0b6d034f97b279c03665f8b948eec Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:26:23 -0600 Subject: [PATCH 1/2] Flake8 doc/conf --- doc/conf.py | 166 ++++++++++++++++++++-------------------------------- 1 file changed, 65 insertions(+), 101 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 586a06c..ccbeb5d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -12,87 +12,85 @@ from __future__ import absolute_import # All configuration values have a default; values that are commented out # serve to show the default. -#import os -#import sys - # 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. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- 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.ext.viewcode", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # 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'modepy' -copyright = u'2013 Andreas Klöckner, Tim Warburton, Jan Hesthaven' +project = u"modepy" +copyright = u"2013 Andreas Klöckner, Tim Warburton, Jan Hesthaven" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # ver_dic = {} -exec(compile(open("../modepy/version.py").read(), "../modepy/version.py", 'exec'), ver_dic) +exec(compile(open("../modepy/version.py").read(), "../modepy/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"] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # 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 +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# 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 = [] +# modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- @@ -107,11 +105,11 @@ html_theme_options = { } html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', - 'searchbox.html', + "**": [ + "about.html", + "navigation.html", + "relations.html", + "searchbox.html", ] } @@ -119,150 +117,116 @@ html_sidebars = { # 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 = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # 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, # so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] +# html_static_path = ['_static'] -# 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' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'modepydoc' +htmlhelp_basename = "modepydoc" # -- Options for LaTeX output -------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', + # The paper size ("letterpaper" or "a4paper"). + # "papersize": "letterpaper", -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', + # The font size ("10pt", "11pt" or "12pt"). + # "pointsize": "10pt", -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # Additional stuff for the LaTeX preamble. + # "preamble": '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'modepy.tex', u'modepy Documentation', - u'Andreas Kloeckner, Tim Warburton, Jan Hesthaven', 'manual'), + ("index", "modepy.tex", u"modepy Documentation", + u"Andreas Kloeckner, Tim Warburton, Jan Hesthaven", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'modepy', u'modepy Documentation', - [u'Andreas Kloeckner, Tim Warburton, Jan Hesthaven'], 1) -] +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------------ - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'modepy', u'modepy Documentation', - u'Andreas Kloeckner, Tim Warburton, Jan Hesthaven', 'modepy', 'One line description of project.', - 'Miscellaneous'), -] +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# latex_domain_indices = True # Example configuration for intersphinx: refer to the Python standard library. -- GitLab From 9e8114f58c8763f8f950fd5b9827470c3a92d827 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:29:20 -0600 Subject: [PATCH 2/2] Switch to furo doc theme --- doc/conf.py | 21 ++++----------------- doc/index.rst | 2 ++ 2 files changed, 6 insertions(+), 17 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index ccbeb5d..d3dfdf8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -29,6 +29,7 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx.ext.mathjax", # "sphinx.ext.viewcode", + "sphinx_copybutton", ] # Add any paths that contain templates here, relative to this directory. @@ -95,25 +96,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/modepy", - "💾 Download Releases": "https://pypi.python.org/pypi/modepy", - } } -html_sidebars = { - "**": [ - "about.html", - "navigation.html", - "relations.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. @@ -231,8 +218,8 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "https://docs.python.org/": None, - "https://docs.scipy.org/doc/numpy/": None, + "https://docs.python.org/3/": None, + "https://numpy.org/doc/stable/": None, "https://documen.tician.de/pytools": None, "https://documen.tician.de/pymbolic": None, } diff --git a/doc/index.rst b/doc/index.rst index 7dfe6cd..348787f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -47,6 +47,8 @@ Contents quadrature tools misc + 🚀 Github + 💾 Download Releases * :ref:`genindex` * :ref:`modindex` -- GitLab