Merge pull request #461 from nschloe/new-sphinx

New sphinx

Author: nschloe

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2010-2020 Nico Schlömer
+Copyright (c) 2010-2021 Nico Schlömer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -27,3 +27,6 @@ format:
 lint:
 	black --check .
 	flake8 .
+
+doc:
+	sphinx-build -M html doc/ build/

doc/Makefile

@@ -2,61 +2,46 @@
 #
 # 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
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
 
+import pathlib
+
 # 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.
 #
-import os
-
+# import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+from configparser import ConfigParser
 
 # -- Project information -----------------------------------------------------
-
 project = "tikzplotlib"
-copyright = "2010-2020, Nico Schlömer"
+copyright = "2010-2021, Nico Schlömer"
 author = "Nico Schlömer"
 
-# 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 full version, including alpha/beta/rc tags.
-release = about["__version__"]
-
-# WARNING: conf value "version" should not be empty for EPUB3
-version = about["__version__"]
+p = ConfigParser()
+this_dir = pathlib.Path(__file__).resolve().parent
+p.read(this_dir / ".." / "setup.cfg")
+release = p["metadata"]["version"]
 
-# for sphinx 1.*
-master_doc = "index"
 
 # -- 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",
-]
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # 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"]
+exclude_patterns = []
 
 
 # -- Options for HTML output -------------------------------------------------

doc/conf.py

@@ -1,15 +1,14 @@
 .. tikzplotlib documentation master file, created by
-   sphinx-quickstart on Tue Jul 30 11:59:20 2019.
+   sphinx-quickstart on Thu Feb  4 12:49:27 2021.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
 Welcome to tikzplotlib's documentation!
-===========================================
-
-Contents:
+=======================================
 
 .. toctree::
    :maxdepth: 2
+   :caption: Contents:
 
 Methods
 =======

doc/index.rst

@@ -7,22 +7,26 @@
 STEP_DRAW_STYLES = ["steps-pre", "steps-post", "steps-mid"]
 
 
-def clean_figure(fig=None, target_resolution=600, scale_precision=1.0):
+def clean_figure(fig=None, target_resolution: int = 600, scale_precision: float = 1.0):
     """Cleans figure as a preparation for tikz export.
     This will minimize the number of points required for the tikz figure.
     If the figure has subplots, it will recursively clean then up.
 
     Note that this function modifies the figure directly (impure function).
 
     :param fig: Matplotlib figure handle (Default value = None)
+
     :param target_resolution: target resolution of final figure in PPI.
-        If a scalar integer is provided, it is assumed to be square in both axis.
-        If a list or an np.array is provided, it is interpreted as [H, W].
-        By default 600
+                              If a scalar integer is provided, it is assumed to be
+                              square in both axis.  If a list or an np.array is
+                              provided, it is interpreted as [H, W].
+                              By default 600
     :type target_resolution: int, list or np.array, optional
+
     :param scalePrecision: scalar value indicating precision when scaling down.
-        By default 1
+                           By default 1
     :type scalePrecision: float, optional
+
     Examples
     --------
 

doc/requirements.txt

@@ -3,6 +3,7 @@
 import pathlib
 import tempfile
 import warnings
+from typing import List, Optional, Set, Union
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
@@ -17,26 +18,26 @@
 
 def get_tikz_code(
     figure="gcf",
-    filepath=None,
-    axis_width=None,
-    axis_height=None,
-    textsize=10.0,
-    tex_relative_path_to_data=None,
-    externalize_tables=False,
-    override_externals=False,
-    strict=False,
-    wrap=True,
-    add_axis_environment=True,
-    extra_axis_parameters=None,
-    extra_groupstyle_parameters={},
-    extra_tikzpicture_parameters=None,
-    dpi=None,
-    show_info=False,
-    include_disclaimer=True,
-    standalone=False,
-    float_format=".15g",
-    table_row_sep="\n",
-    flavor="latex",
+    filepath: Optional[Union[str, pathlib.Path]] = None,
+    axis_width: Optional[str] = None,
+    axis_height: Optional[str] = None,
+    textsize: float = 10.0,
+    tex_relative_path_to_data: Optional[str] = None,
+    externalize_tables: bool = False,
+    override_externals: bool = False,
+    strict: bool = False,
+    wrap: bool = True,
+    add_axis_environment: bool = True,
+    extra_axis_parameters: Optional[Union[List, Set]] = None,
+    extra_groupstyle_parameters: dict = {},
+    extra_tikzpicture_parameters: Optional[Union[List, Set]] = None,
+    dpi: Optional[int] = None,
+    show_info: bool = False,
+    include_disclaimer: bool = True,
+    standalone: bool = False,
+    float_format: str = ".15g",
+    table_row_sep: str = "\n",
+    flavor: str = "latex",
 ):
     """Main function. Here, the recursion into the image starts and the
     contents are picked up. The actual file gets written in this routine.
@@ -156,11 +157,12 @@ def get_tikz_code(
     if filepath:
         filepath = pathlib.Path(filepath)
         data["output dir"] = filepath.parent
+        data["base name"] = filepath.stem
     else:
         directory = tempfile.mkdtemp()
         data["output dir"] = pathlib.Path(directory)
+        data["base name"] = "tmp"
 
-    data["base name"] = filepath.stem if filepath else "tmp"
     data["strict"] = strict
     data["tikz libs"] = set()
     data["pgfplots libs"] = set()
@@ -239,7 +241,9 @@ def get_tikz_code(
     return code
 
 
-def save(filepath, *args, encoding=None, **kwargs):
+def save(
+    filepath: Union[str, pathlib.Path], *args, encoding: Optional[str] = None, **kwargs
+):
     """Same as `get_tikz_code()`, but actually saves the code to a file.
 
     :param filepath: The file to which the TikZ output will be written.