# 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 sys
+import ast
+from pathlib import Path
+import re
-import recommonmark
+from recommonmark.parser import CommonMarkParser
-sys.path.insert(0, os.path.abspath('.' ))
+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))
+
# -- Project information -----------------------------------------------------
author = 'Łukasz Langa and contributors to Black'
# Autopopulate version
-import black
-# The short X.Y version.
-# TODO: fix for 2 digit month
-version = f'{black.__version__[:4]}'
# The full version, including alpha/beta/rc tags.
-release = black.__version__
+release = get_version()
+# The short X.Y version.
+version = release
+for sp in 'abcfr':
+ version = version.split(sp)[0]
# -- General configuration ---------------------------------------------------
templates_path = ['_templates']
source_parsers = {
- '.md': 'recommonmark.parser.CommonMarkParser',
+ '.md': CommonMarkParser,
}
# The suffix(es) of source filenames.
html_theme_options = {
'show_related': True,
- 'description': 'The uncompromising Python code formatter',
+ 'description': '“Any color you like.”',
+ 'github_button': True,
'github_user': 'ambv',
'github_repo': 'black',
- 'github_button': True,
+ 'github_type': 'star',
'show_powered_by': True,
'fixed_sidebar': True,
+ 'logo': 'logo2.png',
}
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- (master_doc, 'black', 'Documentation for black',
+ (master_doc, 'black', 'Documentation for Black',
[author], 1)
]
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/3/': None}
\ No newline at end of file
+intersphinx_mapping = {'https://docs.python.org/3/': None}