Bug 1232403 - Upgrade to sphinx-js 2.8. r=ahal

This should fix the doc builds on Windows, as sphinx-js added Windows support in 2.3.1 and 2.4. We also now get support for variadic args, @deprecated, and @see, along with other features. sphinx-js 2.7.1 changed the default cwd to be the one containing conf.py, so I also had to twiddle `jsdoc_config_path`. Let some other pipenv pinnings update themselves as well, as, if I don't, they'll just update themselves the next time somebody runs `mach doc`, dirtying their tree. I suspect this also fixes bug 1556460, whose equivalent bug in sphinx-js is mozilla/sphinx-js#106. IOW, it should no longer break with versions of jsdoc >= 3.6. Differential Revision: https://phabricator.services.mozilla.com/D48122
mozilla-spidermonkey · Oct 3, 2019 · 7a29dfe · 7a29dfe
1 parent 951c9ae
commit 7a29dfe
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 36 deletions.
diff --git a/tools/docs/Pipfile b/tools/docs/Pipfile
@@ -11,7 +11,7 @@ livereload = "~=2.6.0"
 recommonmark = "~=0.4.0"
 scandir = "~=1.9.0"
 singledispatch = "~=3.4.0"
-sphinx-js = "~=2.1.0"
+sphinx-js = "~=2.8"
 sphinx-rtd-theme = "~=0.4.2"
 sphinxcontrib-mermaid = "~=0.3.1"
 sphinx = "~=1.8.5"

diff --git a/tools/docs/Pipfile.lock b/tools/docs/Pipfile.lock
diff --git a/tools/docs/conf.py b/tools/docs/conf.py
@@ -54,7 +54,7 @@
     'toolkit/mozapps/extensions',
 ]
 root_for_relative_js_paths = '.'
-jsdoc_config_path = 'tools/docs/jsdoc.json'
+jsdoc_config_path = 'jsdoc.json'
 
 templates_path = ['_templates']
 source_suffix = '.rst'