docs: versioning like readthedocs for documentation

hzdr · Nov 14, 2018 · 972b229 · 972b229
1 parent 654ece0
commit 972b229
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -75,14 +75,18 @@ install:
 
 script:
   - "sh run-tests.sh"
-
 jobs:
   include:
     - stage: test
       script:
         - "sh run-tests.sh"
       after_success:
         - coveralls
+    - python: 3.6
+      env: REQUIREMENTS=release EXTRAS=all,sqlite
+      script:
+        - pip install -U git+https://github.com/leokoppel/sphinxcontrib-versioning.git#egg=sphinxcontrib-versioning
+        - sphinx-versioning build -T -W "^v[0-9\.]*$" -w master docs/source docs/build/html
     - stage: deploy-pypi
       python: "3.6"
       env: REQUIREMENTS=release EXTRAS=all,sqlite SQLALCHEMY_DATABASE_URI="sqlite:///test.db"
@@ -101,7 +105,9 @@ jobs:
     - stage: deploy-docs
       python: "3.6"
       env: REQUIREMENTS=release EXTRAS=all,sqlite SQLALCHEMY_DATABASE_URI="sqlite:///test.db"
-      script: sphinx-build -qnNW docs/source docs/build/html
+      script:
+        - pip install -U git+https://github.com/leokoppel/sphinxcontrib-versioning.git#egg=sphinxcontrib-versioning
+        - sphinx-versioning build -T -W "^v[0-9\.]*$" -w master docs/source docs/build/html
       before_deploy:
         - "touch docs/build/html/.nojekyll"
       deploy:

diff --git a/INSTALL.rst b/INSTALL.rst
@@ -44,4 +44,4 @@ Or the latest development branch directly from GitHub:
 
 .. code-block:: console
 
-  $ pip install git+git://github.com/tobiasfrust/shibboleth-authenticator@master
+  $ pip install git+https://github.com/tobiasfrust/shibboleth-authenticator@master