From 6fa2752fcb2eff5be72187c321ebec92b86e67c0 Mon Sep 17 00:00:00 2001 From: Mike Shoup Date: Fri, 26 Jul 2019 08:31:39 -0600 Subject: [PATCH] Add doc8 linting --- .drone.yml | 13 +++++++++++++ docs/_static/.gitkeep | 0 docs/index.rst | 12 ++---------- requirements-dev.txt | 1 + 4 files changed, 16 insertions(+), 10 deletions(-) create mode 100644 docs/_static/.gitkeep diff --git a/.drone.yml b/.drone.yml index 710ae4a..d5b3af0 100644 --- a/.drone.yml +++ b/.drone.yml @@ -30,6 +30,19 @@ steps: - black --check src tests setup.py - flake8 +--- +kind: pipeline +name: docs + +steps: +- name: tests + image: python:3.6 + commands: + # Install pre-requisites + - pip install -r requirements-dev.txt + # Perform linting + - doc8 docs --ignore-path docs/_build + --- kind: pipeline name: publish diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.rst b/docs/index.rst index 53dca9f..3cccf6f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,8 @@ Humulus ======= -Humulus is an open-source homebrew beer recipe webapp built using Flask_ and CouchDB_. +Humulus is an open-source homebrew beer recipe webapp built using Flask_ and +CouchDB_. .. _Flask: http://couchdb.apache.org/ .. _CouchDB: http://flask.pocoo.org/ @@ -15,15 +16,6 @@ Humulus is an open-source homebrew beer recipe webapp built using Flask_ and Cou contributing - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - - License ------- diff --git a/requirements-dev.txt b/requirements-dev.txt index 126645d..5f6a952 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -5,4 +5,5 @@ black flake8 sphinx-click sphinx_rtd_theme +doc8 -e .