- -
Current version: {{ release }}
-Downloads: -
- try pip install wxmplot -
+
Install: pip install wxmplot +
Develop: + github.com +
-Development version:
github.com
-
diff --git a/doc/conf.py b/doc/conf.py index 1767dbd5..dbeca11a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -10,159 +10,43 @@ import sys from datetime import date -# 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.append(os.path.abspath(os.path.join('.'))) +from packaging.version import parse as version_parse -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +import wxmplot -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +project = 'wxmplot' +copyright = f'{date.today()}, Matthew Newville, The University of Chicago' -extensions = ['sphinx.ext.autodoc', - 'sphinx.ext.mathjax', - 'sphinx.ext.napoleon', - 'sphinxcontrib.video'] +release = version_parse(wxmplot.__version__).public -autoclass_content = 'both' +html_title = "WXMPLOT: interactive plotting with Python" +html_short_title = "WXMPLOT: wxPython+matplotlib" -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +# sys.path.append(os.path.abspath(os.path.join('.'))) +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.mathjax', + 'sphinx.ext.napoleon', 'sphinxcontrib.video'] -# The suffix of source filenames. +autoclass_content = 'both' +templates_path = ['_templates'] source_suffix = {'.rst': 'restructuredtext'} - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. master_doc = 'index' -# General information about the project. -project = u'wxmplot' -copyright = u'{}, Matthew Newville, The University of Chicago'.format(date.today().year) - -# 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. -# -# The short X.Y version. -try: - import wxmplot - release = wxmplot.__version__.split('+', 1)[0] -except ImportError: - release = '0.1' - - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. exclude_trees = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. default_role = None -# If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). add_module_names = False - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. html_theme_path = ['sphinx_theme'] -html_theme = 'sphinxdoc' - - -html_title = "WXMPLOT: plotting widgets using wxPython and matplotlib" -html_short_title = "WXMPLOT: wxPython+matplotlib" +html_theme = 'bizstyle' -#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 - -# 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'] - -# 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' - -# Custom sidebar templates, maps document names to template names. html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']} - html_domain_indices = False html_use_index = True -#html_split_index = False - -# If true, links to the reST sources are added to the pages. html_show_sourcelink = 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 = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'wxmplotdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'wxmplot.tex', u'wxmplot documentation', - u'Matthew Newville', 'manual'), -] - -# # configuration for jupyter_sphinx -# package_path = os.path.abspath('../..') -# os.environ['PYTHONPATH'] = ':'.join((package_path, os.environ.get('PYTHONPATH', ''))) -# -# image_converter_args=["-density", "300"] -# -# # Sphinx-gallery configuration -# sphinx_gallery_conf = { -# 'examples_dirs': '../examples', -# 'gallery_dirs': 'examples', -# 'filename_pattern': '/documentation|/example_', -# 'ignore_pattern': '/doc_', -# 'expected_failing_examples': ['../examples/documentation/model_loadmodel.py'] -# } +latex_documents = [('index', 'wxmplot.tex', 'wxmplot documentation', + 'Matthew Newville', 'manual')] diff --git a/doc/installation.rst b/doc/installation.rst index 4bed800e..58924c13 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -15,9 +15,9 @@ The wxmplot package requires Python 3.7 or higher, wxPython 4.1.0 or higher, matplotlib 3.5.0 or higher, numpy 1.18 or higher, and Pillow 7.0 or higher. All of these are readily available from `pip` or on `conda` channels. -. + Installation -~~~~~~~~~~~~~ +~~~~~~~~~~~~~~ The latest version (|release|) is available from `PyPI`_ or `github`_, and the package can be installed with::