diff --git a/doc/conf.py b/doc/conf.py index 2b47e9e4bf04b05d848814a78d0ceccf0d78aa9d..84b51663cfd9161822a5bbcc7b2632a713a5354d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -9,12 +9,12 @@ # All configuration values have a default value; values that are commented out # serve to show the default value. -#import sys, os +# import sys, os # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. -#sys.path.append(os.path.abspath('some/directory')) +# sys.path.append(os.path.abspath('some/directory')) # General configuration # --------------------- @@ -22,25 +22,26 @@ # 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.intersphinx', - 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', - ] + "sphinx.ext.intersphinx", + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx_copybutton", +] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] -exclude_patterns = ['subst.rst'] +exclude_patterns = ["subst.rst"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General substitutions. -project = 'PyOpenCL' -copyright = '2009, Andreas Kloeckner' +project = "PyOpenCL" +copyright = "2009, Andreas Kloeckner" # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. @@ -49,95 +50,82 @@ copyright = '2009, Andreas Kloeckner' ver_dic = {} with open("../pyopencl/version.py") as ver_file: ver_src = ver_file.read() -exec(compile(ver_src, "../pyopencl/version.py", 'exec'), ver_dic) +exec(compile(ver_src, "../pyopencl/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"] # 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 documents that shouldn't be included in the build. -#unused_docs = [] +# unused_docs = [] # List of directories, relative to source directories, that shouldn't be searched # for source files. -#exclude_dirs = [] +# exclude_dirs = [] # 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" # 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 # given in html_static_path. -#html_style = 'default.css' +# html_style = 'default.css' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # The name of an image file (within the static path) to place at the top of # the sidebar. -#html_logo = None +# html_logo = 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_use_modindex = True +# html_use_modindex = True # If true, the reST sources are included in the HTML build as _sources/. html_copy_source = False @@ -145,52 +133,52 @@ html_copy_source = False # 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 = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +# html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'PyOpenClDoc' +htmlhelp_basename = "PyOpenClDoc" # Options for LaTeX output # ------------------------ # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'pyopencl.tex', 'PyOpenCL Documentation', - 'Andreas Kloeckner', 'manual'), - ] + ("index", "pyopencl.tex", "PyOpenCL Documentation", "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 # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_use_modindex = True +# latex_use_modindex = True intersphinx_mapping = { - 'https://docs.python.org/dev': None, - 'https://numpy.org/doc/stable/': None, - 'https://docs.makotemplates.org/en/latest/': None, - } + "https://docs.python.org/dev": None, + "https://numpy.org/doc/stable/": None, + "https://docs.makotemplates.org/en/latest/": None, +} autoclass_content = "both" 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 - `_ offers a variety of GPU-enabled non-linear optimization algorithms + `_ 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 + 💾 Download Releases Note that this guide does not explain OpenCL programming and technology. Please refer to the official `Khronos OpenCL documentation `_