Switch to the pipenv and Sphinx>=1.8 to build docs.

40ants · Jan 13, 2019 · d847fc0 · d847fc0
1 parent 9b4c30f
commit d847fc0
Show file tree

Hide file tree

Showing 5 changed files with 230 additions and 4 deletions.
diff --git a/Pipfile b/Pipfile
@@ -0,0 +1,15 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+sphinx = ">=1.8"
+pygments-cl-repl = "*"
+sphinx-bootstrap-theme = "*"
+sphinxcontrib-cldomain = {git = "https://github.com/40ants/sphinxcontrib-cldomain.git",editable = true}
+
+[requires]
+python_version = "2.7"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/build-docs-on-ci.sh b/build-docs-on-ci.sh
@@ -9,8 +9,9 @@ set -e
 # TRAVIS_BRANCH=reblocks, but TRAVIS_PULL_REQUEST_BRANCH=the-branch
 # and TRAVIS_PULL_REQUEST=42 where 42 is a pull request number
 if [ "$TRAVIS_BRANCH" = "reblocks" -a "$TRAVIS_PULL_REQUEST" = "false" -a "$LISP" = "ccl" ]; then
-    sudo pip install -r docs/requirements.txt
-    ./build-docs.ros
+    sudo pip install pipenv
+    pipenv install
+    pipenv run ./build-docs.ros
 else
     echo "Skipping documentation build because environment is not suitable."
 fi
diff --git a/docs/requirements.in b/docs/requirements.in
@@ -1,5 +1,5 @@
 # to build documentation
-sphinx
+sphinx>=1.8
 pygments-cl-repl
 sphinx-bootstrap-theme
 releases

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,7 +36,7 @@
     'sphinx.ext.autosectionlabel',
     'sphinxcontrib.cldomain',
     'sphinxcontrib.hyperspec',
-    'releases',
+    # 'releases', # it does not work with Sphinx >= 1.8 yet
 ]
 
 from os.path import join, dirname, realpath, expandvars