[tor-commits] [sbws/master] CI: check broken links in the docs

juga at torproject.org juga at torproject.org
Fri Dec 21 09:11:50 UTC 2018


commit c6a7a94adf960a412b097ea05f5a5dae380bcd6e
Author: juga0 <juga at riseup.net>
Date:   Thu Nov 29 19:00:51 2018 +0000

    CI: check broken links in the docs
    
    Add a tox environment to check the links and call it from travis.
    It's not run by tox in order to do not need Internet running tox.
    The environment clean is also call from travis, in order to have
    sphinx installed when checking the links.
    
    Closes #28670.
---
 .travis.yml |  7 ++++++-
 tox.ini     | 14 ++++++++++----
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 3f19a7d..b6ac5ca 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -4,7 +4,12 @@ python:
   - "3.5"
   - "3.6"
 install: pip install tox-travis
-script: tox
+script:
+  - tox
+  # This is not in included in the tox envlist, in order to don't need Internet
+  # when running tox
+  - tox -e doclinks
+  - tox -e clean
 
 before_install:
     - gpg --version
diff --git a/tox.ini b/tox.ini
index af89ea8..eb6a958 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,10 +1,10 @@
 [tox]
 skip_missing_interpreters = True
-envlist = py35, py36, inst, setup, unit, integration, lint, stats, doc, clean
+envlist = py35, py36, inst, setup, unit, integration, lint, stats, doc
 
 [travis]
 python =
-    3.5: py35, inst, setup, unit, integration, lint, doc
+    3.5: py35, inst, setup, unit, integration, lint, doc, doclinks
     3.6: py36, inst, setup, unit, integration
 
 [testenv]
@@ -82,6 +82,12 @@ commands =
     make html
     # this requires build the pdf images
     # make latexpdf
-    # this requires network
-    # make linkcheck
     make man
+
+# this requires Internet, it should not be in envlist
+[testenv:doclinks]
+deps = .[doc]
+whitelist_externals = make
+changedir = docs
+commands =
+    make linkcheck





More information about the tor-commits mailing list