Add Travis-CI tests for docs

.travis.yml

@@ -90,6 +90,9 @@ addons:
         - pyenv
     update: true
 
+before_install:
+  - chmod +x ./docs/scripts/sphinx_build_link_check.sh
+  - chmod +x ./docs/scripts/doc8_style_check.sh
 
 install:
   - ./configure
@@ -99,6 +102,11 @@ script:
   # - ./bin/py.test -n 2 -vvs --cov=src tests/scancode
   # - echo $TEST_SUITE
   - $TEST_SUITE
+  # Documentation Test Scripts
+  - source bin/activate
+  - cd docs
+  - "./scripts/sphinx_build_link_check.sh"
+  - "./scripts/doc8_style_check.sh"
 
 # Pay attention to both calls below. They will succeed even if there
 # is no coverage information or connection to reporting website fails.

docs/requirements.txt

@@ -0,0 +1,29 @@
+alabaster==0.7.12
+Babel==2.7.0
+certifi==2019.9.11
+chardet==3.0.4
+doc8==0.8.0
+docutils==0.15.2
+idna==2.8
+imagesize==1.1.0
+Jinja2==2.10.3
+MarkupSafe==1.1.1
+packaging==19.2
+pbr==5.4.3
+Pygments==2.4.2
+pyparsing==2.4.2
+pytz==2019.3
+requests==2.22.0
+restructuredtext-lint==1.3.0
+six==1.12.0
+snowballstemmer==2.0.0
+Sphinx==2.2.0
+sphinx-rtd-theme==0.4.3
+sphinxcontrib-applehelp==1.0.1
+sphinxcontrib-devhelp==1.0.1
+sphinxcontrib-htmlhelp==1.0.2
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==1.0.2
+sphinxcontrib-serializinghtml==1.1.3
+stevedore==1.31.0
+urllib3==1.25.6

docs/scripts/doc8_style_check.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+# halt script on error
+set -e
+# Check for Style Code Violations
+doc8 --max-line-length 100 source --ignore D000 --quiet

docs/scripts/sphinx_build_link_check.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+# halt script on error
+set -e
+# Build locally, and then check links
+sphinx-build -E -W -b linkcheck source build

docs/source/conf.py

@@ -49,6 +49,6 @@
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 master_doc = 'index'

docs/source/doc_maintenance.rst

@@ -44,7 +44,8 @@ Now you can build the HTML documents locally::
     cd docs
     make html
 
-Assuming that your Sphinx installation was successful, Sphinx should build a local instance of the documentation .html files::
+Assuming that your Sphinx installation was successful, Sphinx should build a local instance of the
+documentation .html files::
 
     open build/html/index.html
 
@@ -60,7 +61,8 @@ Ensure that you have the latest ScanCode Toolkit files::
     git pull
     git status
 
-Use your favorite text editor to create and modify .rst files to make your documentation improvements.
+Use your favorite text editor to create and modify .rst files to make your documentation
+improvements.
 
 Review your work::
 
@@ -71,7 +73,8 @@ Review your work::
 Share ScanCode Toolkit Document Improvements
 --------------------------------------------
 
-Follow standard git procedures to upload your new and modified files. The following commands are examples::
+Follow standard git procedures to upload your new and modified files. The following commands are
+examples::
 
     git status
     git add source/index.rst
@@ -82,4 +85,5 @@ Follow standard git procedures to upload your new and modified files. The follow
     git push
     git status
 
-The ScanCode Toolkit webhook with ReadTheDocs should rebuild the documentation. You can review your results online.
+The ScanCode Toolkit webhook with ReadTheDocs should rebuild the documentation. You can review your
+results online.

docs/source/index.rst

@@ -33,7 +33,8 @@ Reference documents describe application concepts in depth.
 Discussion Documents
 ====================
 
-Discussion documents provide insights into integration of the application into your own software development life cycle.
+Discussion documents provide insights into integration of the application into your own software
+development life cycle.
 
 
 Indices and Tables

setup.py

@@ -221,6 +221,12 @@ def read(*names, **kwargs):
         'spdx-tools >= 0.6.0',
         'unicodecsv',
 
+        # ScanCode Docs
+        'Sphinx <  2.0; python_version == "2.7"',
+        'Sphinx >= 2.0; python_version > "3"',
+        'sphinx_rtd_theme >= 0.4.3',
+        'doc8 >= 0.8.0',
+
         # ScanCode caching and locking
         'yg.lockfile >= 2.3, < 3.0.0',
             # used by yg.lockfile

thirdparty/Babel-2.7.0-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: Babel-2.7.0-py2.py3-none-any.whl
+name: Babel
+version: 2.7.0
+checksum_md5: b96fe47047fd07bc5797779d903d4fe2
+checksum_sha1: 6145459f9d7a875b10695874588044157cff58be
+package_url: pkg:pypi/babel@2.7.0
+download_url: https://files.pythonhosted.org/packages/2c/60/f2af68eb046c5de5b1fe6dd4743bf42c074f7141fe7b2737d3061533b093/Babel-2.7.0-py2.py3-none-any.whl
+notice_url: https://github.com/babel/babel/blob/master/LICENSE
+homepage_url: http://babel.pocoo.org/en/latest/
+owner_url: https://github.com/babel
+owner:  Armin Ronacher
+contact: armin.ronacher@active-4.com
+license_expression: bsd-new
+licenses:
+-   key: bsd-new
+    name: BSD-3-Clause
+copyright: Copyright (c) 2014-present Sebastian McKenzie and other contributors

thirdparty/Sphinx-1.8.5-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,21 @@
+about_resource: Sphinx-1.8.5-py2.py3-none-any.whl
+name: Sphinx
+version: 1.8.5 
+checksum_md5: ec23368cfce52febb348def5cf7e988f
+checksum_sha1: b519aa4248cdf2e6cdc93c5392670c25aab86a2b
+package_url: pkg:pypi/sphinx@1.8.5
+download_url: https://files.pythonhosted.org/packages/7d/66/a4af242b4348b729b9d46ce5db23943ce9bca7da9bbe2ece60dc27f26420/Sphinx-1.8.5-py2.py3-none-any.whl
+notice_url: https://github.com/sphinx-doc/sphinx/blob/v1.8.5/LICENSE
+homepage_url: https://github.com/sphinx-doc/sphinx
+owner_url: https://github.com/birkenfeld
+owner: Georg Brandl
+contact: georg@python.org
+license_expression: bsd-simplified OR bsd-new OR mit
+licenses:
+-   key: bsd-simplified
+    name: BSD-2-Clause
+-   key: bsd-new
+    name: BSD-3-Clause
+-   key: mit
+    name: MIT License
+copyright: Copyright (c) 2007-2019 by the Sphinx team

thirdparty/Sphinx-2.2.0-py3-none-any.whl.ABOUT

@@ -0,0 +1,21 @@
+about_resource: Sphinx-2.2.0-py3-none-any.whl
+name: Sphinx
+version: 2.2.0 
+checksum_md5: a0931694d72db70085581c3bd3b06709
+checksum_sha1: bb05a79ba2558679931952212ce6834874af121c
+package_url: pkg:pypi/sphinx@2.2.0
+download_url: https://files.pythonhosted.org/packages/8e/4c/95a21788db2e1653e931420f561015a0bbc9bd4660c4520467ab9e733eb2/Sphinx-2.2.0-py3-none-any.whl
+notice_url: https://github.com/sphinx-doc/sphinx/blob/v2.2.0/LICENSE
+homepage_url: https://github.com/sphinx-doc/sphinx
+owner_url: https://github.com/birkenfeld
+owner: Georg Brandl
+contact: georg@python.org
+license_expression: bsd-simplified OR bsd-new OR mit
+licenses:
+-   key: bsd-simplified
+    name: BSD-2-Clause
+-   key: bsd-new
+    name: BSD-3-Clause
+-   key: mit
+    name: MIT License
+copyright: Copyright (c) 2007-2019 by the Sphinx team

thirdparty/alabaster-0.7.12-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: alabaster-0.7.12-py2.py3-none-any.whl
+name: alabaster
+version: 0.7.12
+checksum_md5: 6487fd5054a3eece3a6b96bda83d97b2
+checksum_sha1: 2f921fdec63547d20d171de41bc50916aebf5fd2
+package_url: pkg:pypi/alabaster@0.7.12
+download_url: https://files.pythonhosted.org/packages/10/ad/00b090d23a222943eb0eda509720a404f531a439e803f6538f35136cae9e/alabaster-0.7.12-py2.py3-none-any.whl
+notice_url: https://github.com/bitprophet/alabaster/blob/0.7.12/LICENSE
+homepage_url: https://github.com/bitprophet/alabaster
+owner_url: https://github.com/bitprophet
+owner: Jeff Forcier
+contact: jeff@bitprophet.org
+license_expression: bsd-new
+licenses:
+-   key: bsd-new
+    name: BSD-3-Clause
+copyright: Copyright (c) 2018 Jeff Forcier

thirdparty/doc8-0.8.0-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: doc8-0.8.0-py2.py3-none-any.whl
+name: doc8
+version: 0.8.0
+checksum_md5: 0980c7c6e4b06b6e35ba0db2a7cafc21
+checksum_sha1: 99220f4d00158e8bd1156481a7808c5f000e074c
+package_url: pkg:pypi/doc8@0.8.0
+download_url: https://files.pythonhosted.org/packages/d8/39/5427135280657da69b800cebb153f40b5f3209c636659c35a19c8760428a/doc8-0.8.0-py2.py3-none-any.whl
+notice_url: https://github.com/PyCQA/doc8/blob/0.8.0/LICENSE
+homepage_url: https://github.com/PyCQA/doc8
+owner_url: https://github.com/PyCQA
+owner: OpenStack
+contact: openstack-dev@lists.openstack.org
+license_expression: apache-2.0
+licenses:
+-   key: apache-2.0
+    name: Apache 2.0 License
+copyright: Copyright (c) OpenStack

thirdparty/docutils-0.15.2-py2-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: docutils-0.15.2-py2-none-any.whl
+name: docutils
+version: 0.15.2-py2
+checksum_md5: f662aa234d4a07533f5d1ceae221597a
+checksum_sha1: 8e276524c5a76b03ab98e02908a1d48023f5c573
+package_url: pkg:pypi/docutils@0.15.2
+download_url: https://files.pythonhosted.org/packages/3a/dc/bf2b15d1fa15a6f7a9e77a61b74ecbbae7258558fcda8ffc9a6638a6b327/docutils-0.15.2-py2-none-any.whl
+notice_url: https://github.com/docutils-mirror/docutils/blob/master/licenses/BSD-2-Clause.txt
+homepage_url: http://docutils.sourceforge.net/
+owner_url: https://pypi.org/user/goodger/
+owner: David Goodger
+contact: docutils-develop@lists.sourceforge.net
+license_expression: bsd-simplified
+licenses:
+-   key: bsd-simplified
+    name: BSD-2-Clause
+copyright: Copyright (c) David Goodger

thirdparty/docutils-0.15.2-py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: docutils-0.15.2-py3-none-any.whl
+name: docutils
+version: 0.15.2-py3
+checksum_md5: d1a2ad1eaafdddfceda3c5c8b9850a48
+checksum_sha1: aafeddc912b74557754b2aaece3f1364be8e9f6a
+package_url: pkg:pypi/docutils@0.15.2
+download_url: https://files.pythonhosted.org/packages/22/cd/a6aa959dca619918ccb55023b4cb151949c64d4d5d55b3f4ffd7eee0c6e8/docutils-0.15.2-py3-none-any.whl
+notice_url: https://github.com/docutils-mirror/docutils/blob/master/licenses/BSD-2-Clause.txt
+homepage_url: http://docutils.sourceforge.net/
+owner_url: https://pypi.org/user/goodger/
+owner: David Goodger
+contact: docutils-develop@lists.sourceforge.net
+license_expression: bsd-simplified
+licenses:
+-   key: bsd-simplified
+    name: BSD-2-Clause
+copyright: Copyright (c) David Goodger

thirdparty/imagesize-1.1.0-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: imagesize-1.1.0-py2.py3-none-any.whl
+name: imagesize
+version: 1.1.0
+checksum_md5: e2defb5e1f937b87a0ed68868688df21
+checksum_sha1: df96cce25497eaf87b008774f30089077c7f62e1
+package_url: pkg:pypi/imagesize@1.1.0
+download_url: https://files.pythonhosted.org/packages/fc/b6/aef66b4c52a6ad6ac18cf6ebc5731ed06d8c9ae4d3b2d9951f261150be67/imagesize-1.1.0-py2.py3-none-any.whl
+notice_url: https://github.com/shibukawa/imagesize_py/blob/1.1.0/LICENSE.rst
+homepage_url: https://github.com/shibukawa/imagesize_py
+owner_url: https://github.com/shibukawa
+owner: Yoshiki Shibukawa
+contact: yoshiki@shibu.jp
+license_expression: mit
+licenses:
+-   key: mit
+    name: MIT License
+copyright: Copyright © 2016 Yoshiki Shibukawa

thirdparty/pbr-5.4.3-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: pbr-5.4.3-py2.py3-none-any.whl
+name: pbr
+version: 5.4.3
+checksum_md5: 6d1d7eb7c367f10dc8a6ee94ff8f1c2c
+checksum_sha1: 36b9e585c533c75739d48e7cec69b66ed2ba45b7
+package_url: pkg:pypi/pbr@5.4.3
+download_url: https://files.pythonhosted.org/packages/46/a4/d5c83831a3452713e4b4f126149bc4fbda170f7cb16a86a00ce57ce0e9ad/pbr-5.4.3-py2.py3-none-any.whl
+notice_url: https://github.com/openstack/pbr/blob/5.4.3/LICENSE
+homepage_url: https://docs.openstack.org/pbr/latest/
+owner_url: https://github.com/openstack/
+owner: OpenStack
+contact: openstack-discuss@lists.openstack.org
+license_expression: apache-2.0
+licenses:
+-   key: apache-2.0
+    name: Apache 2.0 License
+copyright: Copyright (c) OpenStack

thirdparty/restructuredtext_lint-1.3.0-cp27-none-any.whl.ABOUT

@@ -0,0 +1,15 @@
+about_resource: restructuredtext_lint-1.3.0-cp27-none-any.whl
+name: restructuredtext_lint
+version: 1.3.0-cp27
+package_url: pkg:pypi/restructuredtext_lint@1.3.0
+download_url: https://github.com/twolfson/restructuredtext-lint/archive/1.3.0.tar.gz
+notice_url: https://github.com/twolfson/restructuredtext-lint/blob/v1.3.0/LICENSE
+homepage_url: https://github.com/twolfson/restructuredtext-lint/
+owner_url: https://github.com/twolfson/
+owner: Todd Wolfson
+contact: todd@twolfson.com
+license_expression: unlicense
+licenses:
+-   key: unlicense
+    name: The Unlicense
+copyright: Copyright (c) Todd Wolfson 

thirdparty/restructuredtext_lint-1.3.0-cp36-none-any.whl.ABOUT

@@ -0,0 +1,15 @@
+about_resource: restructuredtext_lint-1.3.0-cp36-none-any.ABOUT
+name: restructuredtext_lint
+version: 1.3.0-cp36
+package_url: pkg:pypi/restructuredtext_lint@1.3.0
+download_url: https://github.com/twolfson/restructuredtext-lint/archive/1.3.0.tar.gz
+notice_url: https://github.com/twolfson/restructuredtext-lint/blob/v1.3.0/LICENSE
+homepage_url: https://github.com/twolfson/restructuredtext-lint/
+owner_url: https://github.com/twolfson/
+owner: Todd Wolfson
+contact: todd@twolfson.com
+license_expression: unlicense
+licenses:
+-   key: unlicense
+    name: The Unlicense
+copyright: Copyright (c) Todd Wolfson 

thirdparty/snowballstemmer-2.0.0-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,19 @@
+about_resource: snowballstemmer-2.0.0-py2.py3-none-any.whl
+name: snowballstemmer
+version: 2.2.0
+checksum_md5: e5e7ab4d8fe1010d1838d061b22e6ea6
+checksum_sha1: 2a3c44768f4c9af9c644d97ad02710ac59f416ca
+package_url: pkg:pypi/snowballstemmer@2.0.0
+download_url: https://files.pythonhosted.org/packages/7d/4b/cdf1113a0e88b641893b814e9c36f69a6fda28cd88b62c7f0d858cde3166/snowballstemmer-2.0.0-py2.py3-none-any.whl
+notice_url: https://github.com/sphinx-doc/sphinx/blob/v2.2.0/LICENSE
+homepage_url: https://github.com/snowballstem/snowball
+owner_url: https://github.com/snowballstem
+owner:  Snowball Developers
+contact: snowball-discuss@lists.tartarus.org
+license_expression: bsd-new
+licenses:
+-   key: bsd-new
+    name: BSD-3-Clause
+copyright: 
+- Copyright (c) 2001, Dr Martin Porter
+- Copyright (c) 2004,2005, Richard Boulton

thirdparty/sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl
+name: sphinx_rtd_theme
+version: 0.4.3
+checksum_md5: d1d2b14a87e6f2e78e14e9b74432def0
+checksum_sha1: c5cf21f4fd3110c657b983cc5f17d6a5bf33d40d
+package_url: pkg:pypi/sphinx-rtd-theme@0.4.3
+download_url: https://files.pythonhosted.org/packages/60/b4/4df37087a1d36755e3a3bfd2a30263f358d2dea21938240fa02313d45f51/sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl
+notice_url: https://github.com/readthedocs/sphinx_rtd_theme/blob/0.4.3/LICENSE
+homepage_url: https://github.com/readthedocs/sphinx_rtd_theme
+owner_url: https://readthedocs.org/
+owner: Dave Snider, Read the Docs, Inc. & contributors
+contact: dev@readthedocs.org
+license_expression: mit
+licenses:
+-   key: mit
+    name: MIT License
+copyright: Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors

thirdparty/sphinxcontrib_applehelp-1.0.1-py2.py3-none-any.whl.ABOUT

@@ -0,0 +1,17 @@
+about_resource: sphinxcontrib_applehelp-1.0.1-py2.py3-none-any.whl
+name: sphinxcontrib_applehelp
+version: 1.0.1
+checksum_md5: 098c7bd28ba940494ffd3bb92c0b55e1
+checksum_sha1: 82f3d93c260a03a6bdc9264b91d45143ba0c184d
+package_url: pkg:pypi/sphinxcontrib-applehelp@1.0.1
+download_url: https://files.pythonhosted.org/packages/13/9a/4428b3114d654cb1cd34d90d5e6fab938d5436f94a571155187ea1dd78b4/sphinxcontrib_applehelp-1.0.1-py2.py3-none-any.whl
+notice_url: https://github.com/sphinx-doc/sphinxcontrib-applehelp/blob/master/LICENSE
+homepage_url: https://github.com/sphinx-doc/sphinxcontrib-applehelp/
+owner_url: https://github.com/birkenfeld
+owner: Georg Brandl
+contact: georg@python.org
+license_expression: bsd-new
+licenses:
+-   key: bsd-new
+    name: BSD-3-Clause
+copyright: Copyright (c) 2007-2019 by the Sphinx team