Tox setup (google#597)

* change?

* resolved conflicts

* Added tox test for documents validity.

* Back to weird newline error...

* this takes care of untouched files

* Changed travis config

* Changed travis configs2

* fixed the tox issue

* Added tox to requirements

* Removed tox from requirements

* changed the tox config

* removed python from tox

* Update install.md

Co-authored-by: Aaron Peterson <[email protected]>

Author: alimez

.gitignore

@@ -11,6 +11,7 @@
 /build/
 */_build/
 /_sources/
+/.tox
 
 # And don't care about the 'egg'.
 /turbinia.egg-info

.travis.yml

@@ -6,8 +6,10 @@ cache:
 
 install:
   - pip install mock nose coverage yapf
+  - pip install tox
   - pip install .
   - pip install .[local]
 
 script:
   - ./run_tests.py
+  - tox --sitepackages ${TOXENV}

docs/developer/contributing.md

@@ -37,9 +37,9 @@ To update your local repo from the main:
 
 Please follow the Style Guide when making your changes, and also make sure to
 use the project's
-[pylintrc](https://github.com/google/turbinia/blob/master/turbinia/config/pylintrc)
+[pylintrc](https://github.com/google/turbinia/blob/master/.pylintrc)
 and
-[yapf config file](https://github.com/google/turbinia/blob/master/turbinia/config/style.yapf).
+[yapf config file](https://github.com/google/turbinia/blob/master/.style.yapf).
 Once you're ready for review make sure the tests pass:
 
     $ pip install -e .[dev]

docs/user/install.md

@@ -9,6 +9,8 @@ documentation for more details on what the architecture looks like for each of
 these installation types. This doc covers the recommended quick installation
 instructions for Cloud installations. This uses
 [terraform configs](https://github.com/forseti-security/osdfir-infrastructure)
+that are part of the
+[Forseti Security repository](https://github.com/forseti-security)
 to automate deployment of Turbinia into an existing GCP Project. If you want to
 install Turbinia in hybrid or local only mode, or want to install Turbinia
 manually (not recommended), see
@@ -67,7 +69,7 @@ to get a shell with access to your GCP resources.
             create a [Timesketch](http://timesketch.org) instance in the same
             project, and this can be configured to ingest Turbinia timeline
             output and report data. See the
-            [Documentation on this](https://github.com/forseti-security/osdfir-infrastructure/blob/master/README.md)
+            [Documentation on this](https://github.com/forseti-security/osdfir-infrastructure)
             for more details.
         *   When prompted for the project name, enter the project you selected
             during setup.

tox.ini

@@ -0,0 +1,10 @@
+[tox]
+envlist = docs
+
+[testenv:docs]
+usedevelop = true
+deps =
+    -rdocs/requirements.txt
+commands = 
+	sphinx-build -b html -d build/doctrees docs dist/docs
+	sphinx-build -b linkcheck docs dist/docs