From 7a2b8019a0d7d4180c43fd138f172c892d38a363 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Tue, 11 Aug 2020 15:26:16 +0000 Subject: [PATCH] Bug 1657926 - Move to sphinx 3.1.2 and sphinx-js 3.0.1 r=championshuttler Hopefully, it will help with the intermittent issues. And it seems that the warnings are better presented. Differential Revision: https://phabricator.services.mozilla.com/D86361 --- docs/conf.py | 20 ++++++++--------- tools/moztreedocs/Pipfile | 4 ++-- tools/moztreedocs/Pipfile.lock | 40 +++++++++++++++++++++++++--------- 3 files changed, 42 insertions(+), 22 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2668b8e045fc..b2ab3e0c06fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,16 +51,16 @@ extensions = [ # JSDoc must run successfully for dirs specified, so running # tree-wide (the default) will not work currently. js_source_path = [ - "browser/components/extensions", - "browser/components/uitour", - "testing/marionette", - "toolkit/components/extensions", - "toolkit/components/extensions/parent", - "toolkit/components/featuregates", - "toolkit/mozapps/extensions", - "toolkit/components/prompts/src", -] -root_for_relative_js_paths = "." + "../browser/components/extensions", + "../browser/components/uitour", + "../testing/marionette", + "../toolkit/components/extensions", + "../toolkit/components/extensions/parent", + "../toolkit/components/featuregates", + "../toolkit/mozapps/extensions", + "../toolkit/components/prompts/src", + ] +root_for_relative_js_paths = ".." jsdoc_config_path = "jsdoc.json" templates_path = ["_templates"] diff --git a/tools/moztreedocs/Pipfile b/tools/moztreedocs/Pipfile index a2bd936cc61c..0deef3e0f9d5 100644 --- a/tools/moztreedocs/Pipfile +++ b/tools/moztreedocs/Pipfile @@ -12,10 +12,10 @@ python-frontmatter = "~=0.4.5" recommonmark = "~=0.6.0" scandir = "~=1.9.0" singledispatch = "~=3.4.0" -sphinx-js = "~=2.8" +sphinx-js = "~=3.0.1" sphinx-rtd-theme = "~=0.4.3" sphinxcontrib-mermaid = "~=0.4.0" -sphinx = "~=2.2.2" +sphinx = "~=3.1.2" sphinx-markdown-tables = "~=0.0.15" tornado = "~=6.0.3" sphinx-copybutton = "~=0.2.12" diff --git a/tools/moztreedocs/Pipfile.lock b/tools/moztreedocs/Pipfile.lock index 675db0128fa0..e19ccc59c195 100644 --- a/tools/moztreedocs/Pipfile.lock +++ b/tools/moztreedocs/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "fbad15083637a21000642225a4bb8524a53d9df25c3e02aeaa77383a9c8b45f5" + "sha256": "49f9b4b08cc993f7d2ae9f68b200df70afa556c9d26dfc19dc387654fefad81d" }, "pipfile-spec": 6, "requires": { @@ -28,6 +28,7 @@ "sha256:1aac2ae2d0d8ea368fa90906567f5c08463d98ade155c0c4bfedd6a0f7160e38", "sha256:d670ea0b10f8b723672d3a6abeb87b565b244da220d76b4dba1b66269ec152d4" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==2.8.0" }, "backports-abc": { @@ -80,6 +81,7 @@ "sha256:9e4d7ecfc600058e07ba661411a2b7de2fd0fafa17d1a7f7361cd47b1175c827", "sha256:a2aeea129088da402665e92e0b25b04b073c04b2dce4ab65caaa38b7ce2e1a99" ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==0.15.2" }, "fluent.pygments": { @@ -102,6 +104,7 @@ "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6", "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==2.10" }, "imagesize": { @@ -109,6 +112,7 @@ "sha256:6965f19a6a2039c7d48bca7dba2473069ff854c36ae6f19d2cde309d998228a1", "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==1.2.0" }, "jinja2": { @@ -116,6 +120,7 @@ "sha256:89aab215427ef59c34ad58735269eb58b1a5808103067f7bb9d5836c651b3bb0", "sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", "version": "==2.11.2" }, "jmespath": { @@ -123,6 +128,7 @@ "sha256:b85d0567b8666149a93172712e68920734333c0ce7e89b78b3e987f71e5ed4f9", "sha256:cdf6525904cc597730141d61b36f2e4b8ecc257c420fa2f4549bac2c2d0cb72f" ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==0.10.0" }, "livereload": { @@ -137,6 +143,7 @@ "sha256:1fafe3f1ecabfb514a5285fca634a53c1b32a81cb0feb154264d55bf2ff22c17", "sha256:c467cd6233885534bf0fe96e62e3cf46cfc1605112356c4f9981512b8174de59" ], + "markers": "python_version >= '3.5'", "version": "==3.2.2" }, "markupsafe": { @@ -175,6 +182,7 @@ "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7", "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==1.1.1" }, "packaging": { @@ -182,6 +190,7 @@ "sha256:4357f74f47b9c12db93624a82154e9b120fa8293699949152b22065d556079f8", "sha256:998416ba6962ae7fbd6596850b80e17859a5753ba17c32284f67bfff33784181" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==20.4" }, "parsimonious": { @@ -195,6 +204,7 @@ "sha256:647344a061c249a3b74e230c739f434d7ea4d8b1d5f3721bc0f3558049b38f44", "sha256:ff7a40b4860b727ab48fad6360eb351cc1b33cbf9b15a0f689ca5353e9463324" ], + "markers": "python_version >= '3.5'", "version": "==2.6.1" }, "pyparsing": { @@ -202,6 +212,7 @@ "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1", "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b" ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==2.4.7" }, "python-dateutil": { @@ -256,6 +267,7 @@ "sha256:b3559a131db72c33ee969480840fff4bb6dd111de7dd27c8ee1f820f4f00231b", "sha256:fe75cc94a9443b9246fc7049224f75604b113c36acb93f87b80ed42c44cbb898" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'", "version": "==2.24.0" }, "s3transfer": { @@ -295,6 +307,7 @@ "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259", "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced" ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", "version": "==1.15.0" }, "snowballstemmer": { @@ -306,11 +319,11 @@ }, "sphinx": { "hashes": [ - "sha256:3b16e48e791a322d584489ab28d8800652123d1fbfdd173e2965a31d40bf22d7", - "sha256:559c1a8ed1365a982f77650720b41114414139a635692a23c2990824d0a84cf2" + "sha256:97dbf2e31fc5684bb805104b8ad34434ed70e6c588f6896991b2fdfd2bef8c00", + "sha256:b9daeb9b39aa1ffefc2809b43604109825300300b987a24f45976c001ba1a8fd" ], "index": "pypi", - "version": "==2.2.2" + "version": "==3.1.2" }, "sphinx-copybutton": { "hashes": [ @@ -322,11 +335,11 @@ }, "sphinx-js": { "hashes": [ - "sha256:8c6775b8be82b6edbac12e1f8b590e6f5a24585549bd18043ec47d1051560de2", - "sha256:c7a97c4d23d592d41a38fc9c6b3a5902578ad1bfcf0ed5094691909fd5f372cd" + "sha256:00d8d8bb4fe0e4c8cf940c7412af257c7fb83eaedc69d79765f9a012d719ce20", + "sha256:6dd8e79c5ad09fef389af5021d7a672066f6e12a51130497f6c611544d62734b" ], "index": "pypi", - "version": "==2.8" + "version": "==3.0.1" }, "sphinx-markdown-tables": { "hashes": [ @@ -349,6 +362,7 @@ "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a", "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58" ], + "markers": "python_version >= '3.5'", "version": "==1.0.2" }, "sphinxcontrib-devhelp": { @@ -356,6 +370,7 @@ "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e", "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4" ], + "markers": "python_version >= '3.5'", "version": "==1.0.2" }, "sphinxcontrib-htmlhelp": { @@ -363,6 +378,7 @@ "sha256:3c0bc24a2c41e340ac37c85ced6dafc879ab485c095b1d65d2461ac2f7cca86f", "sha256:e8f5bb7e31b2dbb25b9cc435c8ab7a79787ebf7f906155729338f3156d93659b" ], + "markers": "python_version >= '3.5'", "version": "==1.0.3" }, "sphinxcontrib-jsmath": { @@ -370,6 +386,7 @@ "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178", "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8" ], + "markers": "python_version >= '3.5'", "version": "==1.0.1" }, "sphinxcontrib-mermaid": { @@ -385,6 +402,7 @@ "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72", "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6" ], + "markers": "python_version >= '3.5'", "version": "==1.0.3" }, "sphinxcontrib-serializinghtml": { @@ -392,6 +410,7 @@ "sha256:eaa0eccc86e982a9b939b2b82d12cc5d013385ba5eadcc7e4fed23f4405f77bc", "sha256:f242a81d423f59617a8e5cf16f5d4d74e28ee9a66f9e5b637a18082991db5a9a" ], + "markers": "python_version >= '3.5'", "version": "==1.1.4" }, "tornado": { @@ -411,10 +430,11 @@ }, "urllib3": { "hashes": [ - "sha256:3018294ebefce6572a474f0604c2021e33b3fd8006ecd11d62107a5d2a963527", - "sha256:88206b0eb87e6d677d424843ac5209e3fb9d0190d0ee169599165ec25e9d9115" + "sha256:91056c15fa70756691db97756772bb1eb9678fa585d9184f24534b100dc60f4a", + "sha256:e7983572181f5e1522d9c98453462384ee92a0be7fac5f1413a1e35c56cc0461" ], - "version": "==1.25.9" + "markers": "python_version >= '3.4'", + "version": "==1.25.10" } }, "develop": {}