sphinx_jupyterbook_latex issue

[jbogaardt]

Hi, I cannot seem to get my docs to build per the Developer Guide. As soon as I set autosummary_generate: True, the build fails. The docs I am trying to build are here.

The issue seems to be sphinx_jupyterbook_latex. Any idea what this error is implying?

# Sphinx version: 3.5.4
# Python version: 3.9.7 (CPython)
# Docutils version: 0.16 release
# Jinja2 version: 3.0.1
# Last messages:
#   reading sources... [ 26%] auto_examples/plot_value_at_risk
#   reading sources... [ 27%] auto_examples/plot_voting_chainladder
#   reading sources... [ 28%] auto_examples/sg_execution_times
#   reading sources... [ 29%] intro
#   reading sources... [ 30%] library/contributing
#   reading sources... [ 30%] library/glossary
#   reading sources... [ 31%] library/install
#   reading sources... [ 32%] library/releases
#   reading sources... [ 33%] library/roadmap
#   reading sources... [ 34%] modules/_autosummary/chainladder
# Loaded extensions:
#   sphinx.ext.mathjax (3.5.4) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\ext\mathjax.py
#   sphinxcontrib.applehelp (1.0.2) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinxcontrib\applehelp\__init__.py
#   sphinxcontrib.devhelp (1.0.2) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinxcontrib\devhelp\__init__.py
#   sphinxcontrib.htmlhelp (2.0.0) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinxcontrib\htmlhelp\__init__.py
#   sphinxcontrib.serializinghtml (1.1.5) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinxcontrib\serializinghtml\__init__.py
#   sphinxcontrib.qthelp (1.0.3) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinxcontrib\qthelp\__init__.py
#   alabaster (0.7.12) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\alabaster\__init__.py
#   sphinx_togglebutton (0.2.3) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_togglebutton\__init__.py
#   sphinx_copybutton (0.4.0) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_copybutton\__init__.py
#   myst_nb (0.12.3) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\myst_nb\__init__.py
#   jupyter_book (0.11.3) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\jupyter_book\__init__.py
#   sphinx_thebe (0.0.10) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_thebe\__init__.py
#   sphinx_comments (0.0.3) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_comments\__init__.py
#   sphinx_external_toc (0.2.3) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_external_toc\__init__.py
#   sphinx.ext.intersphinx (3.5.4) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\ext\intersphinx.py
#   sphinx_panels (0.5.2) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_panels\__init__.py
#   sphinx_book_theme (unknown version) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_book_theme\__init__.py
#   sphinx_gallery.gen_gallery (0.10.0) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_gallery\gen_gallery.py
#   sphinx_gallery.load_style (0.10.0) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_gallery\load_style.py
#   sphinx.ext.autodoc.type_comment (3.5.4) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\ext\autodoc\type_comment.py
#   sphinx.ext.autodoc (3.5.4) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\ext\autodoc\__init__.py
#   sphinx.ext.autosummary (3.5.4) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\ext\autosummary\__init__.py
#   numpydoc (1.1.0) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\numpydoc\__init__.py
#   sphinxcontrib.bibtex (2.2.1) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinxcontrib\bibtex\__init__.py
#   sphinx_jupyterbook_latex (unknown version) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_jupyterbook_latex\__init__.py
#   pydata_sphinx_theme (unknown version) from C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\pydata_sphinx_theme\__init__.py
Traceback (most recent call last):
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\jupyter_book\sphinx.py", line 167, in build_sphinx
    app.build(force_all, filenames)
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\application.py", line 352, in build
    self.builder.build_update()
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\builders\__init__.py", line 296, in build_update
    self.build(to_build,
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\builders\__init__.py", line 310, in build
    updated_docnames = set(self.read())
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\builders\__init__.py", line 417, in read
    self._read_serial(docnames)
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\builders\__init__.py", line 438, in _read_serial
    self.read_doc(docname)
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\builders\__init__.py", line 478, in read_doc
    doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\io.py", line 221, in read_doc
    pub.publish()
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\docutils\core.py", line 219, in publish
    self.apply_transforms()
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\docutils\core.py", line 200, in apply_transforms
    self.document.transformer.apply_transforms()
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx\transforms\__init__.py", line 86, in apply_transforms
    super().apply_transforms()
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\docutils\transforms\__init__.py", line 171, in apply_transforms
    transform.apply(**kwargs)
  File "C:\Users\jboga\anaconda3\envs\cl_docs\lib\site-packages\sphinx_jupyterbook_latex\transforms.py", line 304, in apply
    if tocnode.attributes["hidden"]:
KeyError: 'hidden'

[choldgraf]

cc @mmcky and @AakashGfude who have been doing much of the work on that package!

[mmcky]

thanks @jbogaardt for reporting this issue.

@AakashGfude looks like we need to add some testing around autodoc and see why we are interacting here. Perhaps we need to just check if that attribute exists before requesting it.

[mmcky]

actually @jbogaardt that change has already been made.

https://github.com/executablebooks/sphinx-jupyterbook-latex/blob/8cc0a8a61f9c7cba725ebd28f7bfbbb1b3d70718/sphinx_jupyterbook_latex/transforms.py#L304

would you mind updating sphinx-jupyterbook-latex and see if you have any issues after that?

pip install sphinx-jupyterbook-latex --upgrade

it looks like this PR fixed this issue.

[jbogaardt]

Ah, I could have sworn I already did that. Knowing me, I probably upgraded in a different environment. Thank you - you guys do great work. I love the repo.