Adds Travis-CI for sphinx-build and linkcheck

This adds test scripts to check build status of Spinx Documentation along with adding checks for broken links. Also fixes some broken links and updates doc_maintenance.rst

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: python
+python:
+    - "3.6"
+install:
+    - pip install Sphinx sphinx_rtd_theme 
+before_install:
+  - chmod +x ./docs/scripts/sphinx_build_link_check.sh
+script:
+  - cd docs 
+  - ./scripts/sphinx_build_link_check.sh

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/aboutcode-data/abcd.rst

@@ -1,3 +1,5 @@
+.. _aboutcode_data:
+
 AboutCode Data : ABCD 
 =====================
 

docs/source/aboutcode-docs/contributor_project_ideas.rst

@@ -189,8 +189,7 @@ as a 2017 GSoC project) and rename it as the AboutCode server.
 The features of this updated server would be:
 
 
-- Store any ABC data including ScanCode scans See
-  https://github.com/nexB/aboutcode/tree/master/aboutcode-data)
+- Store any ABC data including ScanCode scans See :ref:`aboutcode_data`
 
 - Organize the data in projects (including possibly user-private projects)
 

docs/source/aboutcode-docs/gsoc_2017.rst

@@ -137,7 +137,7 @@ Use automated code translation (for JS) for the port.  Add license expression su
   * https://github.com/nexB/license-expression 
   * https://github.com/bastikr/boolean.py
   * https://github.com/nexB/aboutcode-manager
-  * https://github.com/jashkenas/coffeescript/wiki/list-of-languages-that-compile-to-js#python
+  * https://github.com/jashkenas/coffeescript/wiki/list-of-languages-that-compile-to-js
 
 - **Mentors**  : 
 

docs/source/aboutcode-toolkit/specification.rst

@@ -46,7 +46,7 @@ The meaning of this ABOUT file is:
 - The home URL for this component is http://httpd.apache.org
 
 - The file "httpd-2.4.3.tar.gz" was originally downloaded from
-  http://archive.apache.org/dist/httpd/httpd-2.4.3.tar.gz
+  ``http://archive.apache.org/dist/httpd/httpd-2.4.3.tar.gz``
 
 - In the same directory, "apache-2.0.LICENSE" and "httpd.NOTICE" are files that
   contain respectively the license text and the notice text for this component.
@@ -209,7 +209,7 @@ Field referencing a URL
 
 The value of a field may reference URLs such as a homepage or a download. In
 this case the field name is suffixed with "_url" and the field value must be a
-valid absolute URL starting with ftp://, http:// or https://. URLs are
+valid absolute URL starting with ``ftp://``, ``http://`` or ``https://``. URLs are
 informational and the content they may reference is ignored. For example, a
 download URL is referenced this way::
 

docs/source/deltacode/json_to_csv.rst

@@ -5,12 +5,12 @@ JSON to CSV Conversion
 
 The default output format for a DeltaCode codebase comparison is JSON.  If the ``-j`` or ``--json-file`` option is included in the ``deltacode`` command, the output will be written to a ``.json`` file at the user-designated location.  For example:
 
-.. code-block::
+::
 
    deltacode -n [path to the 'new' codebase] -o [path to the 'old' codebase] -j [path to the JSON output file]
 
 We have also created an easy-to-use script for users who want to convert their JSON output to CSV format.  Located at ``etc/scripts/json2csv.py``\ , the conversion can be run with this command template:
 
-.. code-block::
+::
 
     python etc/scripts/json2csv.py [path to the JSON input file] [path to the CSV output file]

docs/source/deltacode/release_process.rst

@@ -6,7 +6,7 @@ Steps to cut a new release:
 
 run bumpversion with major, minor or patch to bump the version in:
 
-.. code-block::
+::
 
    src/deltacode/__init__.py
    setup.py
@@ -15,14 +15,14 @@ run bumpversion with major, minor or patch to bump the version in:
 Update the CHANGELOG.rst
 commit changes and push changes to develop:
 
-.. code-block::
+::
 
    git commit -m "commit message"
    git push --set-upstream origin develop
 
 merge develop branch in master and tag the release.
 
-.. code-block::
+::
 
    git checkout master
    git merge develop

docs/source/doc_maintenance.rst

@@ -71,6 +71,13 @@ Review your work::
     make html
     open build/html/index.html
 
+AboutCode uses Travis-CI to test build status and check links, so run this script at your local system before creating a Pull Request. 
+
+::
+
+    cd docs
+    ./scripts/sphinx_build_link_check.sh
+
 Share AboutCode Document Improvements
 -------------------------------------
 

docs/source/help.rst

@@ -18,7 +18,7 @@ AboutCode Projects
 
 - `license-expression <https://github.com/nexB/license-expression/>`_: This is a library to parse, analyze, compare and normalize SPDX-like license expressions using a boolean logic expression engine. See https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 to understand what a license expression is. See https://github.com/nexB/license-expression for the code. The underlying boolean engine is at https://github.com/bastikr/boolean.py . Both are co-maintained by @pombredanne
 
-- `ABCD aka AboutCode Data <https://github.com/nexB/aboutcode/blob/master/aboutcode-data/README.rst>`_: is a simple set of conventions to define data structures that all the AboutCode tools can understand and use to exchange data. The specification lives in this repository. .ABOUT files and ScanCode tooklit data are examples of this approach. Other projects such as https://libraries.io and `OSS Review Toolkit <https://github.com/heremaps/oss-review-toolkit>`_ also use these conventions.
+- `ABCD aka AboutCode Data <https://github.com/AyanSinhaMahapatra/aboutcode/blob/master/docs/source/aboutcode-data/abcd.rst>`_: is a simple set of conventions to define data structures that all the AboutCode tools can understand and use to exchange data. The specification lives in this repository. .ABOUT files and ScanCode tooklit data are examples of this approach. Other projects such as https://libraries.io and `OSS Review Toolkit <https://github.com/heremaps/oss-review-toolkit>`_ also use these conventions.
 
 - `DeltaCode <https://github.com/nexB/deltacode>`_ is a command line tool to compare scans and determine if and where there are material differences that affect licensing. The lead maintainer is @majurg