rename

docs/source/conf.py

@@ -1,8 +1,9 @@
 import sys
 import os
 import matplotlib
-sys.path.insert(0, os.path.abspath('../..'))
-matplotlib.use('Agg')
+
+sys.path.insert(0, os.path.abspath("../.."))
+matplotlib.use("Agg")
 # -*- coding: utf-8 -*-
 #
 # Configuration file for the Sphinx documentation builder.
@@ -24,15 +25,21 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'adjustText'
-copyright = '2018, Ilya Flyamer'
-author = 'Ilya Flyamer'
+project = "adjustText"
+copyright = "2018, Ilya Flyamer"
+author = "Ilya Flyamer"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = '0.7'
+def get_version(path):
+    with open(path, "r") as f:
+        _, version = f.read().strip().split("=")
+        version = version.strip().strip('"')
+    return version
+
 
+release = get_version("../../_version.py")
 
 # -- General configuration ---------------------------------------------------
 
@@ -44,25 +51,25 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
-    'nbsphinx',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.napoleon',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "nbsphinx",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "contents"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -74,18 +81,18 @@
 # 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', '**.ipynb_checkpoints']
+exclude_patterns = ["_build", "**.ipynb_checkpoints"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'nature'
+html_theme = "nature"
 
 # 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
@@ -96,7 +103,7 @@
 # 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"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -112,7 +119,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'adjustTextdoc'
+htmlhelp_basename = "adjustTextdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -121,15 +128,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -139,19 +143,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'adjustText.tex', 'adjustText Documentation',
-     'Ilya Flyamer', 'manual'),
+    (
+        master_doc,
+        "adjustText.tex",
+        "adjustText Documentation",
+        "Ilya Flyamer",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'adjusttext', 'adjustText Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "adjusttext", "adjustText Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -160,11 +166,16 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'adjustText', 'adjustText Documentation',
-     author, 'adjustText', 'Auto adjust text for non-overlapping plot.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "adjustText",
+        "adjustText Documentation",
+        author,
+        "adjustText",
+        "Auto adjust text for non-overlapping plot.",
+        "Miscellaneous",
+    ),
 ]
 
 
 # -- Extension configuration -------------------------------------------------
-