Bug 1437526 - [docs] Upgrade doc dependencies to their latest versions, r=davehunt

This upgrades sphinx to version 1.7.5, which contained a couple backwards
incompatible changes that needed fixing.

This also leaves sphinx-js at version 2.1 as upgrading that to 2.5 seems to
introduce an intermittent in the Doc task.

MozReview-Commit-ID: FRUTcXs5yzb

--HG--
extra : rebase_source : e874a2e9c637b7cec710203f75f4dd989a5681a1
This commit is contained in:
Andrew Halberstadt 2018-06-01 10:19:01 -04:00
parent 44b51ac0a2
commit bf87aca534
4 changed files with 47 additions and 26 deletions

View File

@ -8,7 +8,7 @@ import importlib
import os
import sys
from sphinx.util.compat import Directive
from docutils.parsers.rst import Directive
from sphinx.util.docstrings import prepare_docstring

View File

@ -4,14 +4,15 @@ verify_ssl = true
name = "pypi"
[packages]
backports-abc = "==0.5"
boto3 = "==1.4.4"
livereload = "==2.5.1"
recommonmark = "==0.4.0"
singledispatch = "==3.4.0.3"
sphinx = "==1.6.7"
backports-abc = "*"
boto3 = "*"
livereload = "*"
recommonmark = "*"
singledispatch = "*"
sphinx = "*"
# Upgrading to 2.5 causes an intermittent in the Doc task
sphinx-js = "==2.1"
sphinx-rtd-theme = "==0.2.4"
sphinx-rtd-theme = "*"
[requires]
python_version = "2.7"

View File

@ -1,7 +1,7 @@
{
"_meta": {
"hash": {
"sha256": "bd4144a913361336dadcb4eb82b9fc24c6f36b49f7248ab222a1fb688932a1bb"
"sha256": "fbb418ccb5dd2df6bba6010065478d41ac9597a3d7eb0a80880fc1c1a64e2215"
},
"pipfile-spec": 6,
"requires": {
@ -40,18 +40,18 @@
},
"boto3": {
"hashes": [
"sha256:5050c29353fec97301116386f469fa5858ccf47201623b53cf9f74e603bda52f",
"sha256:518f724c4758e5a5bed114fbcbd1cf470a15306d416ff421a025b76f1d390939"
"sha256:19d479abad241512051b11f681b93f37b1e6b03d8f2907daae94b4ca8d0da738",
"sha256:38a811f3335b08690182fdbddb07f0cb5e8f0b5bccbcf9ef606ed2a2508a9fd7"
],
"index": "pypi",
"version": "==1.4.4"
"version": "==1.7.30"
},
"botocore": {
"hashes": [
"sha256:26917b37fe993dc23dd1eb69c3208500fd057dc8b2e18b7c97bb26ae08ce7aa8",
"sha256:471d95025408cfafa30133991f35d2839fcc12a86198465a507499790ee49b4b"
"sha256:1f6d0a135c9505e0840b675e6bd6b556c85df2e63212ac6850f77edf9f68311a",
"sha256:8dac26094f3dbebd2849c0774f050daad3f1abf1b35fad7525916a36372fe009"
],
"version": "==1.5.95"
"version": "==1.10.30"
},
"certifi": {
"hashes": [
@ -119,11 +119,11 @@
},
"livereload": {
"hashes": [
"sha256:422de10d7ea9467a1ba27cbaffa84c74b809d96fb1598d9de4b9b676adf35e2c",
"sha256:5ed6506f5d526ee712da9f3739c27714e6f3376f3e481728d298efceae0ec83a"
"sha256:583179dc8d49b040a9da79bd33de59e160d2a8802b939e304eb359a4419f6498",
"sha256:dd4469a8f5a6833576e9f5433f1439c306de15dbbfeceabd32479b1123380fa5"
],
"index": "pypi",
"version": "==2.5.1"
"version": "==2.5.2"
},
"markupsafe": {
"hashes": [
@ -131,6 +131,13 @@
],
"version": "==1.0"
},
"packaging": {
"hashes": [
"sha256:e9215d2d2535d3ae866c3d6efc77d5b24a0192cce0ff20e42896cc0664f889c0",
"sha256:f019b770dd64e585a99714f1fd5e01c7a8f11b45635aa953fd41c689a657375b"
],
"version": "==17.1"
},
"parsimonious": {
"hashes": [
"sha256:396d424f64f834f9463e81ba79a331661507a21f1ed7b644f7f6a744006fd938"
@ -144,11 +151,24 @@
],
"version": "==2.2.0"
},
"pyparsing": {
"hashes": [
"sha256:0832bcf47acd283788593e7a0f542407bd9550a55a8a8435214a1960e04bcb04",
"sha256:281683241b25fe9b80ec9d66017485f6deff1af5cde372469134b56ca8447a07",
"sha256:8f1e18d3fd36c6795bb7e02a39fd05c611ffc2596c1e0d995d34d67630426c18",
"sha256:9e8143a3e15c13713506886badd96ca4b579a87fbdf49e550dbfc057d6cb218e",
"sha256:b8b3117ed9bdf45e14dcc89345ce638ec7e0e29b2b579fa1ecf32ce45ebac8a5",
"sha256:e4d45427c6e20a59bf4f88c639dcc03ce30d193112047f94012102f235853a58",
"sha256:fee43f17a9c4087e7ed1605bd6df994c6173c1e977d7ade7b651292fab2bd010"
],
"version": "==2.2.0"
},
"python-dateutil": {
"hashes": [
"sha256:1adb80e7a782c12e52ef9a8182bebeb73f1d7e24e374397af06fb4956c8dc5c0",
"sha256:e27001de32f627c22380a688bcc43ce83504a7bc5da472209b4c70f02829f0b8"
],
"markers": "python_version >= '2.7'",
"version": "==2.7.3"
},
"pytz": {
@ -204,11 +224,11 @@
},
"sphinx": {
"hashes": [
"sha256:832bed0dc6099c2abca957d90ff55bc1a6ec4425c13fc144adbae68a970e3775",
"sha256:d5b91b4dad56ffc9f19425ebaa7bc23290a0a2e9035781d5bc54822384663277"
"sha256:85f7e32c8ef07f4ba5aeca728e0f7717bef0789fba8458b8d9c5c294cad134f3",
"sha256:d45480a229edf70d84ca9fae3784162b1bc75ee47e480ffe04a4b7f21a95d76d"
],
"index": "pypi",
"version": "==1.6.7"
"version": "==1.7.5"
},
"sphinx-js": {
"hashes": [
@ -219,11 +239,11 @@
},
"sphinx-rtd-theme": {
"hashes": [
"sha256:2df74b8ff6fae6965c527e97cca6c6c944886aae474b490e17f92adfbe843417",
"sha256:62ee4752716e698bad7de8a18906f42d33664128eea06c46b718fc7fbd1a9f5c"
"sha256:32424dac2779f0840b4788fbccb032ba2496c1ca47a439ad2510c8b1e55dfd33",
"sha256:6d0481532b5f441b075127a2d755f430f1f8410a50112b1af6b069518548381d"
],
"index": "pypi",
"version": "==0.2.4"
"version": "==0.3.1"
},
"sphinxcontrib-websupport": {
"hashes": [

View File

@ -93,7 +93,7 @@ class _SphinxManager(object):
def _generate_python_api_docs(self):
"""Generate Python API doc files."""
out_dir = os.path.join(self.staging_dir, 'python')
base_args = ['sphinx', '--no-toc', '-o', out_dir]
base_args = ['--no-toc', '-o', out_dir]
for p in sorted(self.python_package_dirs):
full = os.path.join(self.topsrcdir, p)
@ -107,7 +107,7 @@ class _SphinxManager(object):
args.append(full)
args.extend(excludes)
sphinx.apidoc.main(args)
sphinx.ext.apidoc.main(argv=args)
def _synchronize_docs(self):
m = InstallManifest()