Continue to avoid Click typing issue (#3791)

[etc/vim.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 7d2b0b134749997fcf6b88f45ccc60b3d125987c..7fc4f8f589eb9fd0639a4269bb0a0b7e5ee8c219 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -12,111 +12,69 @@
 # 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.
 #
 # 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 ast
-from pathlib import Path
-import re
-import shutil
-import string

 
 

-from recommonmark.parser import CommonMarkParser
+import os
+import string
+from pathlib import Path

 
 

+from pkg_resources import get_distribution

 
 CURRENT_DIR = Path(__file__).parent
 
 
 
 CURRENT_DIR = Path(__file__).parent
 
 

-def get_version():
-    black_py = CURRENT_DIR / ".." / "black.py"
-    _version_re = re.compile(r"__version__\s+=\s+(?P<version>.*)")
-    with open(str(black_py), "r", encoding="utf8") as f:
-        version = _version_re.search(f.read()).group("version")
-    return str(ast.literal_eval(version))
-
-
-def make_pypi_svg(version):
-    template = CURRENT_DIR / "_static" / "pypi_template.svg"
-    target = CURRENT_DIR / "_static" / "pypi.svg"
+def make_pypi_svg(version: str) -> None:
+    template: Path = CURRENT_DIR / "_static" / "pypi_template.svg"
+    target: Path = CURRENT_DIR / "_static" / "pypi.svg"

     with open(str(template), "r", encoding="utf8") as f:
     with open(str(template), "r", encoding="utf8") as f:

-        svg = string.Template(f.read()).substitute(version=version)
+        svg: str = string.Template(f.read()).substitute(version=version)

     with open(str(target), "w", encoding="utf8") as f:
         f.write(svg)
 
 
     with open(str(target), "w", encoding="utf8") as f:
         f.write(svg)
 
 

-def make_filename(line):
-    non_letters = re.compile(r"[^a-z]+")
-    filename = line[3:].rstrip().lower()
-    filename = non_letters.sub("_", filename)
-    if filename.startswith("_"):
-        filename = filename[1:]
-    if filename.endswith("_"):
-        filename = filename[:-1]
-    return filename + ".md"
-
-
-def generate_sections_from_readme():
-    target_dir = CURRENT_DIR / "_build" / "generated"
-    readme = CURRENT_DIR / ".." / "README.md"
-    shutil.rmtree(str(target_dir), ignore_errors=True)
-    target_dir.mkdir(parents=True)
-
-    output = None
-    target_dir = target_dir.relative_to(CURRENT_DIR)
-    with open(str(readme), "r", encoding="utf8") as f:
-        for line in f:
-            if line.startswith("## "):
-                if output is not None:
-                    output.close()
-                filename = make_filename(line)
-                output_path = CURRENT_DIR / filename
-                if output_path.is_symlink() or output_path.is_file():
-                    output_path.unlink()
-                output_path.symlink_to(target_dir / filename)
-                output = open(str(output_path), "w", encoding="utf8")
-                output.write(
-                    "[//]: # (NOTE: THIS FILE IS AUTOGENERATED FROM README.md)\n\n"
-                )
-
-            if output is None:
-                continue
-
-            if line.startswith("##"):
-                line = line[1:]
-
-            output.write(line)
-
+# Necessary so Click doesn't hit an encode error when called by
+# sphinxcontrib-programoutput on Windows.
+os.putenv("pythonioencoding", "utf-8")

 
 # -- Project information -----------------------------------------------------
 
 project = "Black"
 
 # -- Project information -----------------------------------------------------
 
 project = "Black"

-copyright = "2018, Łukasz Langa and contributors to Black"
+copyright = "2018-Present, Łukasz Langa and contributors to Black"

 author = "Łukasz Langa and contributors to Black"
 
 # Autopopulate version
 author = "Łukasz Langa and contributors to Black"
 
 # Autopopulate version

-# The full version, including alpha/beta/rc tags.
-release = get_version()
+# The version, including alpha/beta/rc tags, but not commit hash and datestamps
+release = get_distribution("black").version.split("+")[0]

 # The short X.Y version.
 version = release
 for sp in "abcfr":
     version = version.split(sp)[0]
 # The short X.Y version.
 version = release
 for sp in "abcfr":
     version = version.split(sp)[0]

+

 make_pypi_svg(release)
 make_pypi_svg(release)

-generate_sections_from_readme()

 
 
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 
 
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

-#
-# needs_sphinx = '1.0'
+needs_sphinx = "4.4"

 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 
 # 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.intersphinx", "sphinx.ext.napoleon"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "myst_parser",
+    "sphinxcontrib.programoutput",
+    "sphinx_copybutton",
+]
+
+# If you need extensions of a certain version or higher, list them here.
+needs_extensions = {"myst_parser": "0.13.7"}

 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

-source_parsers = {".md": CommonMarkParser}
-

 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 source_suffix = [".rst", ".md"]
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 source_suffix = [".rst", ".md"]


@@ -129,47 +87,40 @@ master_doc = "index"
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.

-language = None
+language = "en"

 
 # 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 .
 
 # 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"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 

+# We need headers to be linkable to so ask MyST-Parser to autogenerate anchor IDs for
+# headers up to and including level 3.
+myst_heading_anchors = 3
+
+# Prettier support formatting some MyST syntax but not all, so let's disable the
+# unsupported yet still enabled by default ones.
+myst_disable_syntax = [
+    "colon_fence",
+    "myst_block_break",
+    "myst_line_comment",
+    "math_block",
+]
+
+# Optional MyST Syntaxes
+myst_enable_extensions = []

 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 
 # -- 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 = "alabaster"
-
-html_sidebars = {
-    "**": [
-        "about.html",
-        "navigation.html",
-        "relations.html",
-        "sourcelink.html",
-        "searchbox.html",
-    ]
-}
-
-html_theme_options = {
-    "show_related": False,
-    "description": "“Any color you like.”",
-    "github_button": True,
-    "github_user": "ambv",
-    "github_repo": "black",
-    "github_type": "star",
-    "show_powered_by": True,
-    "fixed_sidebar": True,
-    "logo": "logo2.png",
-    "travis_button": True,
-}
-
+html_theme = "furo"
+html_logo = "_static/logo2-readme.png"

 
 # 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,
 
 # 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,


@@ -195,21 +146,6 @@ htmlhelp_basename = "blackdoc"
 
 # -- Options for LaTeX output ------------------------------------------------
 
 
 # -- Options for LaTeX output ------------------------------------------------
 

-latex_elements = {
-    # 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',
-}
-

 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).