You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We use myst-nb in the gcm-filters sphinx documentation. Our RTD build environment did not include a pinned version of myst-nb. Once myst-nb 0.12.3 was release, our build broke with an obscure error message.
Traceback (most recent call last):
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/cmd/build.py", line 276, in build_main
app.build(args.force_all, filenames)
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/application.py", line 349, in build
self.builder.build_update()
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 297, in build_update
self.build(to_build,
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 311, in build
updated_docnames = set(self.read())
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 418, in read
self._read_serial(docnames)
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 439, in _read_serial
self.read_doc(docname)
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/builders/__init__.py", line 479, in read_doc
doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/io.py", line 316, in read_doc
pub.publish()
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/docutils/core.py", line 217, in publish
self.document = self.reader.read(self.source, self.parser,
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/sphinx/io.py", line 130, in read
self.parse()
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/docutils/readers/__init__.py", line 77, in parse
self.parser.parse(self.input, document)
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/myst_nb/parser.py", line 69, in parse
md_parser, env, tokens = nb_to_tokens(ntbk)
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/myst_nb/parser.py", line 89, in nb_to_tokens
md = default_parser().disable("front_matter", ignoreInvalid=True)
TypeError: default_parser() missing 1 required positional argument: 'config'
Exception occurred:
File "/home/docs/checkouts/readthedocs.org/user_builds/gcm-filters/conda/34/lib/python3.8/site-packages/myst_nb/parser.py", line 89, in nb_to_tokens
md = default_parser().disable("front_matter", ignoreInvalid=True)
TypeError: default_parser() missing 1 required positional argument: 'config'
The full traceback has been saved in /tmp/sphinx-err-ucrd36ep.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
Pinning to 0.12.2 resolved the problem.
To Reproduce
Steps to reproduce the behavior:
Create the conda environment for our doc build: environment.yml
Thanks for the tip Chris. TBH I don't know the answer to how the environment got configured that way. All I know is that pinning myst_nb to 0.12.2 fixed it.
Based on your analysis (which is much more insightful than mine), it seems likely that that this funky environment and dependency weirdness are the cause of the problems, not anything about myst-nb. So feel free to close this.
I will work on updating / simplifying our environment to see if the issues go away.
Describe the bug
We use myst-nb in the gcm-filters sphinx documentation. Our RTD build environment did not include a pinned version of myst-nb. Once myst-nb 0.12.3 was release, our build broke with an obscure error message.
Pinning to 0.12.2 resolved the problem.
To Reproduce
Steps to reproduce the behavior:
cd docs; make html
Expected behavior
We expected that a bugfix version release (0.12.2 -> 0.12.3) would not contain a breaking change.
cc @NoraLoose, ocean-eddy-cpt/gcm-filters#34 (comment)
The text was updated successfully, but these errors were encountered: