From 23ece1584c2c845c0625e6f2048a95e07d7da2e3 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:49:35 -0600 Subject: [PATCH 1/3] Flake8 doc/conf --- doc/conf.py | 186 ++++++++++++++++++++++++++++------------------------ 1 file changed, 99 insertions(+), 87 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index b8ad993..16bb12b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,4 +1,5 @@ from __future__ import absolute_import + # -*- coding: utf-8 -*- # # pymbolic documentation build configuration file, created by @@ -12,44 +13,44 @@ from __future__ import absolute_import # All configuration values have a default; values that are commented out # serve to show the default. -#import sys, os +# 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. -#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. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - 'sphinx.ext.intersphinx', - 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "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'pymbolic' -copyright = u'2013, Andreas Kloeckner' +project = u"pymbolic" +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 @@ -57,44 +58,47 @@ copyright = u'2013, Andreas Kloeckner' # # The short X.Y version. ver_dic = {} -exec(compile(open("../pymbolic/version.py").read(), "../pymbolic/version.py", 'exec'), ver_dic) +exec( + compile(open("../pymbolic/version.py").read(), "../pymbolic/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 --------------------------------------------------- @@ -102,134 +106,137 @@ pygments_style = 'sphinx' html_theme = "alabaster" html_theme_options = { - "extra_nav_links": { - "🚀 Github": "https://github.com/inducer/pymbolic", - "💾 Download Releases": "https://pypi.python.org/pypi/pymbolic", - } - } + "extra_nav_links": { + "🚀 Github": "https://github.com/inducer/pymbolic", + "💾 Download Releases": "https://pypi.python.org/pypi/pymbolic", + } +} html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', - 'searchbox.html', + "**": [ + "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. -#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, # 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 = 'pymbolicdoc' +htmlhelp_basename = "pymbolicdoc" # -- Options for LaTeX output -------------------------------------------------- latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', + # The paper size ('letterpaper' or 'a4paper'). + #'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + #'pointsize': '10pt', + # 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', 'pymbolic.tex', u'pymbolic Documentation', - u'Andreas Kloeckner', 'manual'), + ( + "index", + "pymbolic.tex", + u"pymbolic Documentation", + u"Andreas Kloeckner", + "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 +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output -------------------------------------------- @@ -237,12 +244,11 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'pymbolic', u'pymbolic Documentation', - [u'Andreas Kloeckner'], 1) + ("index", "pymbolic", u"pymbolic Documentation", [u"Andreas Kloeckner"], 1) ] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ @@ -251,28 +257,34 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'pymbolic', u'pymbolic Documentation', - u'Andreas Kloeckner', 'pymbolic', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "pymbolic", + u"pymbolic Documentation", + u"Andreas Kloeckner", + "pymbolic", + "One line description of project.", + "Miscellaneous", + ), ] # Documents to append as an appendix to all manuals. -#texinfo_appendices = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'http://docs.python.org/dev': None, - 'http://docs.scipy.org/doc/numpy/': None, - 'http://docs.makotemplates.org/en/latest/': None, - 'http://docs.sympy.org/dev/': None, - 'https://galgebra.readthedocs.io/en/latest/': None, - } + "http://docs.python.org/dev": None, + "http://docs.scipy.org/doc/numpy/": None, + "http://docs.makotemplates.org/en/latest/": None, + "http://docs.sympy.org/dev/": None, + "https://galgebra.readthedocs.io/en/latest/": None, +} autoclass_content = "both" -- GitLab From 4a654aedc4253f0a8294f1c7437bc0af5009594c Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:50:03 -0600 Subject: [PATCH 2/3] Flake8 doc/conf, part deux --- doc/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 16bb12b..5287a31 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -33,7 +33,7 @@ extensions = [ "sphinx.ext.intersphinx", "sphinx.ext.coverage", "sphinx.ext.mathjax", - #'sphinx.ext.viewcode' + # 'sphinx.ext.viewcode' ] # Add any paths that contain templates here, relative to this directory. @@ -199,11 +199,11 @@ htmlhelp_basename = "pymbolicdoc" latex_elements = { # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', + # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', + # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. - #'preamble': '', + # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples -- GitLab From cc62f7cc8706d325dff914d124b417963cbd78a4 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Tue, 1 Dec 2020 22:52:06 -0600 Subject: [PATCH 3/3] Switch to furo doc theme --- doc/conf.py | 35 +++++++---------------------------- doc/index.rst | 2 ++ 2 files changed, 9 insertions(+), 28 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 5287a31..7a166b5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,7 +1,3 @@ -from __future__ import absolute_import - -# -*- coding: utf-8 -*- -# # pymbolic documentation build configuration file, created by # sphinx-quickstart on Fri May 24 11:29:00 2013. # @@ -34,6 +30,7 @@ extensions = [ "sphinx.ext.coverage", "sphinx.ext.mathjax", # 'sphinx.ext.viewcode' + "sphinx_copybutton", ] # Add any paths that contain templates here, relative to this directory. @@ -103,28 +100,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/pymbolic", - "💾 Download Releases": "https://pypi.python.org/pypi/pymbolic", - } -} - -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. -# html_theme_options = {} + } # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] @@ -280,10 +259,10 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "http://docs.python.org/dev": None, - "http://docs.scipy.org/doc/numpy/": None, - "http://docs.makotemplates.org/en/latest/": None, - "http://docs.sympy.org/dev/": None, + "https://docs.python.org/3": None, + "https://numpy.org/doc/stable/": None, + "https://docs.makotemplates.org/en/latest/": None, + "https://docs.sympy.org/dev/": None, "https://galgebra.readthedocs.io/en/latest/": None, } diff --git a/doc/index.rst b/doc/index.rst index ebbe469..5c9860d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -23,6 +23,8 @@ Contents algorithms geometric-algebra misc + 🚀 Github + 💾 Download Releases * :ref:`genindex` * :ref:`modindex` -- GitLab