From be563a4748956d30a4224d42902c6f482b256be9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C5=81ukasz=20Langa?= Date: Sat, 24 Mar 2018 17:28:05 -0700 Subject: [PATCH 1/1] More documentation fixes for ReadTheDocs --- docs/conf.py | 26 ++++++++++++++++++-------- docs/requirements.txt | 2 ++ 2 files changed, 20 insertions(+), 8 deletions(-) create mode 100644 docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 4a3c67c..a851f98 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -12,13 +12,23 @@ # 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 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.*)') + 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 ----------------------------------------------------- @@ -27,12 +37,12 @@ copyright = '2018, Łukasz Langa and contributors to Black' 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 --------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..a36fd8a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +recommonmark==0.4.0 +Sphinx==1.7.2 -- 2.39.5