Merge pull request #870 from edx/feanil/fix_docs

docs: Fix building docs.

.travis.yml

@@ -41,6 +41,9 @@ script:
   - make test-docker
   - make quality-docker
   - make coverage-docker
+  # Not running with warnings as errors on because this repo is in maintenance
+  # mode on it's way to being deprecated and so fixing old docs issues in not needed.
+  - sudo make docs
 
 after_success:
   - pip install --upgrade codecov

Makefile

@@ -121,7 +121,6 @@ coverage-local: test-local
 coverage: test coverage-local
 
 docs-requirements:
-	pip install -r requirements/pip.txt
 	pip install -r requirements/docs.txt --no-cache-dir
 	python setup.py install --force
 

requirements/constraints.txt

@@ -0,0 +1,8 @@
+# Newer versions introduce a dependency on charset-normalizer which only supports python 3.6 and above.
+requests==2.25.1
+
+# Newer versions don't support python 2.x
+jinja2==2.11.3
+markupsafe==1.1.1
+pygments==2.5.2
+stevedore==1.32.0

requirements/docs.in

@@ -1,5 +1,7 @@
 # Requirements for documentation validation
 
--r default.txt
+-c constraints.txt
 
+-e git+https://github.com/edx/luigi.git@eb45bcc52243de11b2b16a81229ac584fe1e601b#egg=luigi
 Sphinx==1.5.1
+stevedore

requirements/docs.txt

@@ -1,103 +1,69 @@
 #
-# This file is autogenerated by pip-compile
+# This file is autogenerated by pip-compile with python 3.8
 # To update, run:
 #
 #    make upgrade
 #
---no-binary ansible
-
 -e git+https://github.com/edx/luigi.git@eb45bcc52243de11b2b16a81229ac584fe1e601b#egg=luigi
--e git+https://github.com/edx/pyinstrument.git@a35ff76df4c3d5ff9a2876d859303e33d895e78f#egg=pyinstrument
-alabaster==0.7.12         # via sphinx
-ansible==1.4.5
-argparse==1.2.1
-asn1crypto==1.2.0
-azure-common==1.1.23
-azure-nspkg==3.0.2
-azure-storage-blob==2.1.0
-azure-storage-common==2.1.0
-azure-storage-nspkg==3.1.0
-babel==2.7.0              # via sphinx
-backports-abc==0.5
-bcrypt==3.1.7
-boto3==1.4.8
-boto==2.48.0
-botocore==1.8.50
-cachetools==3.1.1
-certifi==2019.9.11
-cffi==1.13.1
-chardet==3.0.4
-ciso8601==1.0.3
-cryptography==2.8
+    # via -r requirements/docs.in
+alabaster==0.7.12
+    # via sphinx
+babel==2.9.1
+    # via sphinx
+certifi==2021.5.30
+    # via requests
+chardet==4.0.0
+    # via requests
 distlib==0.2.2
-docutils==0.15.2
-ecdsa==0.13
-edx-ccx-keys==0.2.1
-edx-opaque-keys==0.4
-elasticsearch==1.7.0
-enum34==1.1.6
-filechunkio==1.8
-future==0.18.1
-futures==3.3.0
-google-api-python-client==1.7.7
-google-auth-httplib2==0.0.3
-google-auth==1.6.3
-google-cloud-core==0.27.1
-google-resumable-media==0.4.1
-googleapis-common-protos==1.6.0
-graphitesend==0.10.0
-gspread==3.1.0
-html5lib==1.0.1
-httplib2==0.14.0
-idna==2.6
-ijson==2.5.1
-imagesize==1.1.0          # via sphinx
-ipaddress==1.0.23
-isoweek==1.3.3
-jinja2==2.10.3
-jmespath==0.9.4
+    # via luigi
+docutils==0.17.1
+    # via
+    #   python-daemon
+    #   sphinx
+idna==2.10
+    # via requests
+imagesize==1.2.0
+    # via sphinx
+jinja2==2.11.3
+    # via
+    #   -c requirements/constraints.txt
+    #   sphinx
 lockfile==0.12.2
+    # via python-daemon
 markupsafe==1.1.1
-numpy==1.16.5
-oscrypto==1.1.0
-paramiko==2.6.0
-paypalrestsdk==1.9.0
-pbr==5.4.3
-protobuf==3.10.0
-psycopg2==2.6.2
-pyasn1-modules==0.2.7
-pyasn1==0.4.7
-pycparser==2.19
-pycrypto==2.6.1
-pycryptodomex==3.9.0
-pygeoip==0.3.2
-pygments==2.4.2           # via sphinx
-pyjwt==1.7.1
-pymongo==3.9.0
-pynacl==1.3.0
-pyopenssl==19.0.0
-python-cjson==1.1.0
-python-daemon==2.1.2
-python-dateutil==2.6.1
-python-gnupg==0.3.9
-pytz==2017.3
-pyyaml==5.1.2
-requests==2.22.0
-rsa==4.0
-s3transfer==0.1.13
-singledispatch==3.4.0.3
-six==1.10.0
-snowballstemmer==2.0.0    # via sphinx
-snowflake-connector-python==2.0.2
+    # via
+    #   -c requirements/constraints.txt
+    #   jinja2
+pbr==5.6.0
+    # via stevedore
+pygments==2.5.2
+    # via
+    #   -c requirements/constraints.txt
+    #   sphinx
+python-daemon==2.3.0
+    # via luigi
+pytz==2021.1
+    # via babel
+requests==2.25.1
+    # via
+    #   -c requirements/constraints.txt
+    #   sphinx
+six==1.16.0
+    # via
+    #   sphinx
+    #   stevedore
+snowballstemmer==2.1.0
+    # via sphinx
 sphinx==1.5.1
-stevedore==1.19.1
+    # via -r requirements/docs.in
+stevedore==1.32.0
+    # via
+    #   -c requirements/constraints.txt
+    #   -r requirements/docs.in
 tornado==4.5.3
-ua-parser==0.3.6
-uritemplate==3.0.0
-urllib3==1.22
-user-agents==0.3.2
-wheel==0.30.0
-yarn-api-client==0.2.3
+    # via luigi
+urllib3==1.26.6
+    # via requests
 
 # The following packages are considered to be unsafe in a requirements file:
-# setuptools==41.4.0        # via google-cloud-core, protobuf, python-daemon
+# setuptools