Merge pull request #318 from nschloe/doc

update doc

Author: nschloe

.circleci/config.yml

@@ -9,7 +9,7 @@ jobs:
       - run: apt update
       - run: apt install -y python3-pip
       - run: pip3 install -U black flake8
-      - run: LC_ALL=C.UTF-8 black --check setup.py tikzplotlib/ test/*.py
+      - run: LC_ALL=C.UTF-8 black --check .
       - run: flake8 setup.py tikzplotlib/ test/*.py
   build:
     working_directory: ~/work

doc/conf.py

@@ -1,218 +1,67 @@
-# tikzplotlib documentation build configuration file, created by
-# sphinx-quickstart on Mon May 10 14:00:31 2010.
+# Configuration file for the Sphinx documentation builder.
 #
-# This file is execfile()d with the current directory set to its containing
-# dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import os
-import sys
-
-import mock
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
 
-MOCK_MODULES = ["matplotlib"]
-for mod_name in MOCK_MODULES:
-    sys.modules[mod_name] = mock.Mock()
+# -- Path setup --------------------------------------------------------------
 
 # 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("../src"))
-
-# -- General configuration ----------------------------------------------------
-
-# 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.todo",
-    "sphinx.ext.coverage",
-    "sphinx.ext.imgmath",
-]
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
+#
+import os
 
-# The suffix of source filenames.
-source_suffix = ".rst"
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
 
-# The encoding of source files.
-# source_encoding = 'utf-8'
 
-# The master toctree document.
-master_doc = "index"
+# -- Project information -----------------------------------------------------
 
-# General information about the project.
-project = u"tikzplotlib"
-copyright = u"2010-2019, Nico Schlömer"
+project = "tikzplotlib"
+copyright = "2010-2019, Nico Schlömer"
+author = "Nico Schlömer"
 
-# 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.
-#
 # https://packaging.python.org/single_source_version/
 this_dir = os.path.abspath(os.path.dirname(__file__))
 about = {}
 about_file = os.path.join(this_dir, "..", "tikzplotlib", "__about__.py")
 with open(about_file) as f:
     exec(f.read(), about)
-# The short X.Y version.
-version = ".".join(about["__version__"].split(".")[:2])
 # The full version, including alpha/beta/rc tags.
 release = about["__version__"]
 
-# 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
+# -- General configuration ---------------------------------------------------
 
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# 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 = "default"
-
-# 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 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.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.imgmath",
+]
 
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
 
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-# A shorter title for the navigation bar.  Default is the same as html_title.
-# 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
+# -- Options for HTML output -------------------------------------------------
 
-# 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
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
 
 # 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'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_use_modindex = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# 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 <link> 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 = "tikzplotlibdoc"
-
-
-# -- Options for LaTeX output -------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-latex_paper_size = "a4"
-
-# The font size ('10pt', '11pt' or '12pt').
-# latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples (source start
-# file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-    (
-        "index",
-        "tikzplotlib.tex",
-        u"tikzplotlib Documentation",
-        u"Nico Schlömer",
-        "manual",
-    )
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-# latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_use_modindex = True

doc/index.rst

@@ -1,5 +1,5 @@
 .. tikzplotlib documentation master file, created by
-   sphinx-quickstart on Mon May 10 14:00:31 2010.
+   sphinx-quickstart on Tue Jul 30 11:59:20 2019.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.