summaryrefslogtreecommitdiff
path: root/tasks.py
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2019-07-06 13:53:45 -0600
committerkotfu <kotfu@kotfu.net>2019-07-06 13:53:45 -0600
commit9fe8e36a1e26569bdb47b8c361d077675a876af9 (patch)
tree8e72372456ab4f50b61df443fdc1504afb6c1268 /tasks.py
parent6a5b9f8e13c9aed75ea23a23bad8ea0c64e90ff7 (diff)
downloadcmd2-git-9fe8e36a1e26569bdb47b8c361d077675a876af9.tar.gz
Add doc8 documentation style checking
- add dev dependency - add doc8 to tasks.py - fix all doc8 errors
Diffstat (limited to 'tasks.py')
-rw-r--r--tasks.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/tasks.py b/tasks.py
index 4d5a5b64..1521870e 100644
--- a/tasks.py
+++ b/tasks.py
@@ -101,6 +101,12 @@ def docs(context, builder='html'):
context.run(cmdline)
namespace.add_task(docs)
+@invoke.task()
+def doc8(context):
+ "Check documentation with doc8"
+ context.run('doc8 docs --ignore-path _build')
+namespace.add_task(doc8)
+
@invoke.task
def docs_clean(context):
"Remove rendered documentation"
@@ -193,7 +199,7 @@ def validatetag(context):
tag = result.stdout.rstrip()
# Validate that the Git tag appears to be a valid version number
- ver_regex = re.compile('(\d+)\.(\d+)\.(\d+)')
+ ver_regex = re.compile(r'(\d+)\.(\d+)\.(\d+)')
match = ver_regex.fullmatch(tag)
if match is None:
print('Tag {!r} does not appear to be a valid version number'.format(tag))