Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using nullish coalescing operator (??) in files read by jsdoc breaks documentation #150

Open
zombie opened this issue Aug 26, 2020 · 5 comments

Comments

@zombie
Copy link
Member

zombie commented Aug 26, 2020

Originally filed in bug 1649882.

This is very inconvenient, we now use ?? in ~half of our files, but as soon as we introduce it in one of the js files referenced in doc generation, it explodes on Try with a very unhelpful error message.

Is there something we can do here? What code or library is responsible for parsing js files for generated docs? Is there a newer version, do we need to update or something?

@erikrose
Copy link
Contributor

Treeherder shows an error when I click the link. Can you paste the message here?

JSDoc is responsible for doing the parsing. It looks like it supports nullish coalescing. I'll see if I can repro, but it'd help if I could see your error as well.

@erikrose
Copy link
Contributor

erikrose commented Aug 26, 2020

I cannot reproduce a JSDoc crash locally using JSDoc 3.6.3 on this simple file nullish.js:

/**
 * F is awesome.
 */
let f = null;
console.log(f ?? 'itWuzNullish');

jsdoc nullish.js -X doesn't crash and has sane output.

Also, running sphinx-js over the Fathom codebase after inserting a nullish coalescing operator on a documented entity works fine.

So I'm doubly eager to see your error.

@zombie
Copy link
Member Author

zombie commented Aug 26, 2020

Treeherder shows an error when I click the link. Can you paste the message here?

I'm not even sure the error is related, but a bunch of warnings start after reading the extension reference, and then ends up in a python stack trace (apologies for the wall of text):

[task 2020-08-23T18:46:59.224Z] building [mo]: targets for 0 po files that are out of date
[task 2020-08-23T18:46:59.225Z] building [html]: targets for 687 source files that are out of date
[task 2020-08-23T18:46:59.250Z] updating environment: [new config] 687 added, 0 changed, 0 removed
[task 2020-08-23T18:46:59.251Z] reading sources... [  0%] devtools/contributing/react-performance-tips
[task 2020-08-23T18:46:59.459Z] reading sources... [  0%] browser/urlbar/contact
[task 2020-08-23T18:46:59.470Z] reading sources... [  0%] web-platform/running-tests/android_webview

<<< dozens of source dirs without any warnings >>>

[task 2020-08-23T18:47:46.906Z] reading sources... [ 68%] code-quality/lint/linters/black
[task 2020-08-23T18:47:46.922Z] reading sources... [ 68%] toolkit/components/extensions/webextensions/reference
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] element.js:element.find(297):24: (ERROR/3) Unexpected indentation.
[task 2020-08-23T18:47:47.224Z] element.js:element.find(297):29: (ERROR/3) Unexpected indentation.
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.224Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.224Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] message.js:Command(130):18: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
[task 2020-08-23T18:47:47.225Z] message.js:Command(130):25: (ERROR/3) Unexpected indentation.

[task 2020-08-23T18:47:47.225Z] message.js:Command(130):30: (ERROR/3) Unexpected indentation.
[task 2020-08-23T18:47:47.225Z] message.js:Command(130):35: (ERROR/3) Unexpected indentation.
[task 2020-08-23T18:47:47.225Z] message.js:Command(130):40: (ERROR/3) Unexpected indentation.
[task 2020-08-23T18:47:47.225Z] message.js:Command(130):42: (WARNING/2) Definition list ends without a blank line; unexpected unindent.
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
[task 2020-08-23T18:47:47.225Z]   warn("Container node skipped: type={0}".format(mdnode.t))
[task 2020-08-23T18:47:47.225Z] WARNING: the mozbuild.sphinx extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit
[task 2020-08-23T18:47:47.225Z] WARNING: doing serial read

[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/obsolete/hybrid-content.rst:335: WARNING: duplicate label testing, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/contributing/directory_structure.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/uitelemetry.rst:123: WARNING: duplicate label events, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/uitelemetry.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/uitelemetry.rst:318: WARNING: duplicate label sessions, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/uitelemetry.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/components/newtab/docs/index.rst:20: WARNING: duplicate label prerequisites, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/running-tests/android_webview.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/components/newtab/docs/index.rst:61: WARNING: duplicate label running tests, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/running-tests/android_webview.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/testing/marionette/client/marionette_driver/gestures.py:docstring of marionette_driver.gestures.long_press_without_contextmenu:3: WARNING: Field list ends without a blank line; unexpected unindent.
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/third-party-modules-ping.rst:121: WARNING: duplicate label version history, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/obsolete/hybrid-content.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/remote/doc/remote/sting.md:1: WARNING: duplicate label testing, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/obsolete/hybrid-content.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/testing/geckodriver/Usage.md:1: WARNING: duplicate label usage, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/collection/uptake.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/crashreporter/crashreporter/index.rst:6: WARNING: duplicate label overview, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/gfx/AdvancedLayers.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/extensions/webextensions/events.rst:46: WARNING: duplicate label implementing an event, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/extensions/webextensions/events.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/devtools/frontend/telemetry.md:309: WARNING: duplicate label testing, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/remote/doc/remote/sting.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/messaging-system/docs/SpecialMessageActionSchemas/index.md:5: WARNING: duplicate label usage, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/testing/geckodriver/Usage.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/messaging-system/docs/SpecialMessageActionSchemas/index.md:148: WARNING: duplicate label example, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/geckoview/consumer/web-extensions.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/prio-ping.rst:77: WARNING: duplicate label version history, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/third-party-modules-ping.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/installer/windows/installer/StubConfig.rst:8: WARNING: duplicate label architecture, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/devtools/tools/console-panel.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/index.rst:5: WARNING: duplicate label telemetry, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/devtools/frontend/telemetry.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/index.rst:5: WARNING: duplicate label telemetry, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/index.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.compilation.rst:5: WARNING: duplicate label submodules, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/python/marionette_driver.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.compilation.rst:41: WARNING: duplicate label module contents, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/python/marionette_driver.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.test.compilation.rst:5: WARNING: duplicate label submodules, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.compilation.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.test.compilation.rst:17: WARNING: duplicate label module contents, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.compilation.rst
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/submission-process.md:1: WARNING: duplicate label submitting tests, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/index.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/start/adding-a-new-probe.rst:107: WARNING: duplicate label testing, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/devtools/frontend/telemetry.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/geckoview/contributor/geckoview-quick-start.rst:8: WARNING: duplicate label table of contents, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/index.md
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/admin/index.md:1: WARNING: toctree contains reference to nonexisting document 'web-platform/tools/wptserve/docs/index'
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/admin/index.md:1: WARNING: toctree contains reference to nonexisting document 'web-platform/tools/wptrunner/README'
[task 2020-08-23T18:47:47.225Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/admin/index.md:8: WARNING: toctree contains reference to nonexisting document 'web-platform/tools/wptserve/README'
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/js/Debugger/Debugger.Script.md:142: WARNING: duplicate label url, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/messaging-system/docs/SpecialMessageActionSchemas/index.md
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/coverage-ping.rst:36: WARNING: duplicate label version history, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/prio-ping.rst
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/deletion-ping.rst:22: WARNING: duplicate label version history, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/data/coverage-ping.rst
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/components/newtab/docs/v2-system-addon/mochitests.md:12: WARNING: duplicate label writing tests, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/index.md
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/components/newtab/content-src/asrouter/docs/index.rst:86: WARNING: duplicate label detailed docs, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/components/newtab/docs/index.rst
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/js/Debugger/Tutorial-Debugger-Statement.md:: WARNING: image file not readable: js/Debugger/enable-chrome-devtools.png
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/js/Debugger/Tutorial-Debugger-Statement.md:: WARNING: image file not readable: js/Debugger/scratchpad-browser-environment.png
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/js/Debugger/Tutorial-Debugger-Statement.md:: WARNING: image file not readable: js/Debugger/debugger-alert.png
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/taskcluster/taskgraph/test/test_optimize.py:docstring of taskgraph.test.test_optimize.TestOptimize.make_triangle:4: WARNING: Inline interpreted text or phrase reference start-string without end-string.
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/python/taskgraph.test.rst:5: WARNING: duplicate label submodules, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.test.compilation.rst
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/python/taskgraph.test.rst:257: WARNING: duplicate label module contents, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/python/mozbuild.test.compilation.rst
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:25: WARNING: Unknown interpreted text role "js".

[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:25: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:50: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:50: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:61: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:61: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.226Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:71: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:75: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:81: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/intl/locale_startup.rst:91: WARNING: Unknown interpreted text role "js".
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/testing/marionette/Prefs.md:1: WARNING: duplicate label preferences, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/layout/AccessibleCaret.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/github-intro.md:: WARNING: image file not readable: assets/forkbtn.png
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/github-intro.md:: WARNING: image file not readable: assets/praccepteddelete.png
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/web-platform/writing-tests/github-intro.md:281: WARNING: duplicate label cleanup, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/concepts/archiving.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mozbase/mozprofile.rst:56: WARNING: duplicate label preferences, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/testing/marionette/Prefs.md
[task 2020-08-23T18:47:47.227Z] element.js:element.find(297):12: WARNING: Undefined substitution referenced: "timeout".
[task 2020-08-23T18:47:47.227Z] element.js:element.scrollIntoView(1200):9: WARNING: Undefined substitution referenced: "el".
[task 2020-08-23T18:47:47.227Z] element.js:element.getInViewCentrePoint(1132):11: WARNING: Unknown target name: "view".
[task 2020-08-23T18:47:47.227Z] element.js:element.getInViewCentrePoint(1132):11: WARNING: Unknown target name: "point".
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mach/settings.rst:74: WARNING: Unexpected indentation.
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/devtools/contributing/code-reviews-checklist.md:15: WARNING: duplicate label manual testing, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/obsolete/hybrid-content.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/devtools/contributing/code-reviews-checklist.md:23: WARNING: duplicate label automated testing, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/components/telemetry/obsolete/hybrid-content.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/dom/workersAndStorage/CodeStyle.rst:13: WARNING: duplicate label introduction, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/browser/components/enterprisepolicies/docs/index.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/geckoview/contributor/native-debugging.rst:8: WARNING: duplicate label table of contents, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/mobile/android/geckoview/contributor/geckoview-quick-start.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/setup/windows_build.rst:206: WARNING: duplicate label overview, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/toolkit/crashreporter/crashreporter/index.rst
[task 2020-08-23T18:47:47.227Z] /builds/worker/checkouts/gecko/docs-out/html/_staging/setup/windows_build.rst:295: WARNING: duplicate label mozillabuild, other instance in /builds/worker/checkouts/gecko/docs-out/html/_staging/setup/windows_build.rst
[task 2020-08-23T18:47:47.227Z] WARNING: autodoc: failed to import module 'invoke_mach_command' from module 'mach.test'; the following exception was raised:
[task 2020-08-23T18:47:47.227Z] Traceback (most recent call last):
[task 2020-08-23T18:47:47.227Z]   File "/builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/sphinx/ext/autodoc/importer.py", line 32, in import_module
[task 2020-08-23T18:47:47.227Z]     return importlib.import_module(modname)
[task 2020-08-23T18:47:47.227Z]   File "/usr/lib/python3.6/importlib/__init__.py", line 126, in import_module
[task 2020-08-23T18:47:47.227Z]     return _bootstrap._gcd_import(name[level:], package, level)
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 994, in _gcd_import
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 971, in _find_and_load
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap_external>", line 678, in exec_module
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
[task 2020-08-23T18:47:47.227Z]   File "/builds/worker/checkouts/gecko/python/mach/mach/test/invoke_mach_command.py", line 5, in <module>
[task 2020-08-23T18:47:47.227Z]     subprocess.check_call([sys.executable] + sys.argv[1:])
[task 2020-08-23T18:47:47.227Z]   File "/usr/lib/python3.6/subprocess.py", line 311, in check_call
[task 2020-08-23T18:47:47.227Z]     raise CalledProcessError(retcode, cmd)

[task 2020-08-23T18:47:47.227Z] subprocess.CalledProcessError: Command '['/usr/bin/python3', 'doc', '--outdir', 'docs-out', '--no-open', '--no-serve', '--archive']' returned non-zero exit status 2.
[task 2020-08-23T18:47:47.227Z] 
[task 2020-08-23T18:47:47.227Z] WARNING: autodoc: failed to import module 'zero_microseconds' from module 'mach.test'; the following exception was raised:
[task 2020-08-23T18:47:47.227Z] Traceback (most recent call last):
[task 2020-08-23T18:47:47.227Z]   File "/builds/worker/checkouts/gecko/obj-x86_64-pc-linux-gnu/_virtualenvs/docs/lib/python3.6/site-packages/sphinx/ext/autodoc/importer.py", line 32, in import_module
[task 2020-08-23T18:47:47.227Z]     return importlib.import_module(modname)
[task 2020-08-23T18:47:47.227Z]   File "/usr/lib/python3.6/importlib/__init__.py", line 126, in import_module
[task 2020-08-23T18:47:47.227Z]     return _bootstrap._gcd_import(name[level:], package, level)
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 994, in _gcd_import
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 971, in _find_and_load
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 955, in _find_and_load_unlocked
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 665, in _load_unlocked
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap_external>", line 678, in exec_module
[task 2020-08-23T18:47:47.227Z]   File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
[task 2020-08-23T18:47:47.227Z]   File "/builds/worker/checkouts/gecko/python/mach/mach/test/zero_microseconds.py", line 4, in <module>
[task 2020-08-23T18:47:47.227Z]     old = self._mach_context.post_dispatch_handler  # noqa: F821
[task 2020-08-23T18:47:47.227Z] NameError: name 'self' is not defined

@zombie
Copy link
Member Author

zombie commented Aug 26, 2020

I'm sorry I can't help in narrowing this down, but I was never able to run mach doc locally on Windows 10, I get this error:

Collecting colorama>=0.3.5; sys_platform == "win32"
ERROR: In --require-hashes mode, all requirements must have their versions pinned with ==. These do not:
    colorama>=0.3.5; sys_platform == "win32" from https://files.pythonhosted.org/packages/c9/dc/45cdef1b4d119eb96316b3117e6d5708a08029992b2fee2c143c7a0a5cc5/colorama-0.4.3-py2.py3-none-any.whl#sha256=7d73d2a99753107a36ac6b455ee49046802e59d9d076ef8e47b61499fa29afff (from sphinx==3.1.2->-r d:\mozilla\central\tools\moztreedocs\requirements.txt (line 207))

The patch that triggered the jsdoc issue is from bug 1636508, specifically the first version:
https://phabricator.services.mozilla.com/D87971?id=330254#C2933786NL149
This is the Try run from that:
https://treeherder.mozilla.org/#/jobs?repo=try&revision=cbd747218ad0dd416d2c94b8a067c12e0417870a
Just changing ?? to || on that line makes the job on Try pass, it's pretty conclusive.

@erikrose
Copy link
Contributor

I don't see anything sphinx-js-specific in there, though it does look like Sphinx's own autodoc directive is blowing up. :-(

hoodmane added a commit to hoodmane/sphinx-js that referenced this issue May 6, 2024
Add ts source files to manifest

Specify tsconfig.json in cli args to typedoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants