diff --git a/doc/conf.py b/doc/conf.py index 62bafbf0ec1eecfea198957e84985b2ed148e527..d0a6077c2fa5588df90b73e5d523b5fb67a006f1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -21,6 +21,7 @@ extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.mathjax", + "sphinx_copybutton", ] # Add any paths that contain templates here, relative to this directory. @@ -76,24 +77,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/pyvisfile", - "💾 Download Releases": "https://pypi.python.org/pypi/pyvisfile", - } } -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. @@ -102,7 +90,7 @@ html_sidebars = { # 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 = [] # If not "", a "Last updated on:" timestamp is inserted at every page bottom, # using the given strftime format. @@ -156,7 +144,7 @@ latex_documents = [("index", "pyvisfile.tex", # latex_use_modindex = True 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/modepy": None, } diff --git a/doc/index.rst b/doc/index.rst index 3a40556d46d0a4571d178ed2b05feb105495fbbe..cfe4e31ee4cef5aeeaf0e94d83cbc09c837c9658 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,16 +4,16 @@ Welcome to :mod:`pyvisfile`'s documentation! Pyvisfile allows you to write a variety of visualization file formats, including -* `Kitware's `_ +* `Kitware's `_ `XML-style `_ `Vtk `_ data files. * Silo visualization files, as - introduced by LLNL's + introduced by LLNL's `MeshTV `_ and - more recently used by the - `VisIt `_ - large-scale visualization program. + more recently used by the + `VisIt `_ + large-scale visualization program. pyvisfiles supports many mesh geometries, such such as unstructured and rectangular structured meshes, particle meshes, as well as @@ -43,5 +43,7 @@ Table of Contents silo vtk faq + 🚀 Github + 💾 Download Releases * :ref:`genindex`