-
Notifications
You must be signed in to change notification settings - Fork 13
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
Error when including apidoc generated files #73
Comments
Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗 |
I'm also having this issue (preventing docs from building on CI at the moment) jupyter-book 0.11.3 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!
Traceback (most recent call last):
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/jupyter_book/sphinx.py", line 167, in build_sphinx
app.build(force_all, filenames)
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/application.py", line 352, in build
self.builder.build_update()
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 296, in build_update
self.build(to_build,
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 310, in build
updated_docnames = set(self.read())
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 417, in read
self._read_serial(docnames)
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 438, in _read_serial
self.read_doc(docname)
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/builders/__init__.py", line 478, in read_doc
doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/io.py", line 221, in read_doc
pub.publish()
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/docutils/core.py", line 219, in publish
self.apply_transforms()
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/docutils/core.py", line 200, in apply_transforms
self.document.transformer.apply_transforms()
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx/transforms/__init__.py", line 86, in apply_transforms
super().apply_transforms()
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/docutils/transforms/__init__.py", line 171, in apply_transforms
transform.apply(**kwargs)
File "/Users/talley/miniconda3/envs/docs/lib/python3.9/site-packages/sphinx_jupyterbook_latex/transforms.py", line 300, in apply
if tocnode.attributes["hidden"]:
KeyError: 'hidden' |
Describe the problem
If I include sphinx apidoc generated files which contain
:toctree:
directives themselves, I getwhen I run
I wonder why that line is ever called since I don't build anything latex related.
Link to your repository or website
No response
Steps to reproduce
add sphinx apidoc generated
rst
-files liketo the docs folder.
run
jb build
The version of Python you're using
No response
Your operating system
No response
Versions of your packages
Additional context
My current workaround is to change
sphinx-jupyterbook-latex/sphinx_jupyterbook_latex/transforms.py
Line 300 in 43e48a3
into
The error first occurred when updating to
jupyter-book
v0.11, which usessphinx-external-toc
. Therefore executablebooks/sphinx-external-toc#36 may be related.The text was updated successfully, but these errors were encountered: