Open raar1 opened 1 year ago
I'm experiencing the same issue. Do we know why this is happening and how can I resolve?
I have the same issue. It is observed after pydantic migration (from 1.10.2 to 2.1.1).
Instalation of autodoc-pydantic sphinx extension helps for me.
Running into the same issue myself. I've managed to mitigate the issue by fixing Sphinx to version 7.2.6. The issue appears since 7.3.0, but confusingly this only happens in one of the projects inside the organization. All other doc build succeed, even with Sphinx 7.3.7
Could you pinpoint the exact commit please?
Unfortunately I can't, but it must be one of the commits between version 7.2.6 and 7.3.0.
What confuses me, is that it only affects one of the projects, even tho they use a central Sphinx conf.py
with only slight modifications (not affecting viewcode). I will try to dig deeper later
Update: Managed to get the sphinx-err.log
:
# Platform: linux; (Linux-6.5.0-1018-azure-x86_64-with-glibc2.35)
# Sphinx version: 7.3.7
# Python version: 3.12.3 (CPython)
# Docutils version: 0.20.1
# Jinja2 version: 3.1.3
# Pygments version: 2.17.2
# Last messages:
# highlighting module code... [ 71%]
# src.ecu_fota.simulation.state
#
# highlighting module code... [ 79%]
# src.ecu_fota.util
#
# highlighting module code... [ 86%]
# src.mdm_config.util
#
# Needs successfully exported
# Loaded extensions:
# sphinx.ext.mathjax (7.3.7)
# alabaster (0.7.16)
# sphinxcontrib.applehelp (1.0.8)
# sphinxcontrib.devhelp (1.0.6)
# sphinxcontrib.htmlhelp (2.0.5)
# sphinxcontrib.serializinghtml (1.1.10)
# sphinxcontrib.qthelp (1.0.7)
# myst_parser (3.0.0)
# sphinx.ext.autodoc.preserve_defaults (7.3.7)
# sphinx.ext.autodoc.type_comment (7.3.7)
# sphinx.ext.autodoc.typehints (7.3.7)
# sphinx.ext.autodoc (7.3.7)
# sphinx.ext.autosectionlabel (7.3.7)
# sphinx.ext.extlinks (7.3.7)
# sphinx.ext.intersphinx (7.3.7)
# sphinx.ext.napoleon (7.3.7)
# sphinx.ext.todo (7.3.7)
# sphinx.ext.viewcode (7.3.7)
# sphinx.ext.autosummary (7.3.7)
# sphinx.ext.graphviz (7.3.7)
# sphinx.ext.inheritance_diagram (7.3.7)
# autoapi.extension (unknown version)
# sphinx_data_viewer (0.1.4)
# sphinxcontrib.jquery (4.1)
# sphinx_needs (2.0.0)
# sphinx_toolbox.assets (3.5.0)
# sphinx_toolbox.tweaks.tabsize (3.5.0)
# sphinx_toolbox.code (3.5.0)
# sphinx_toolbox.collapse (3.5.0)
# sphinx_toolbox.formatting (3.5.0)
# sphinx_toolbox.github (3.5.0)
# sphinx_toolbox.sidebar_links (3.5.0)
# sphinxcontrib.mermaid (7.3.7)
# sphinxcontrib.plantuml (unknown version)
# sphinxcontrib.test_reports (1.0.2)
# sphinxcontrib.httpdomain (unknown version)
# sphinx_rtd_theme (unknown version)
# Traceback:
Traceback (most recent call last):
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/cmd/build.py", line 337, in build_main
app.build(args.force_all, args.filenames)
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/application.py", line 351, in build
self.builder.build_update()
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 293, in build_update
self.build(to_build,
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 365, in build
self.finish()
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/builders/html/__init__.py", line 676, in finish
self.finish_tasks.add_task(self.gen_pages_from_extensions)
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/util/parallel.py", line 41, in add_task
res = task_func()
^^^^^^^^^^^
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/builders/html/__init__.py", line 696, in gen_pages_from_extensions
for pagename, context, template in pagelist:
File "/opt/hostedtoolcache/Python/3.12.3/x64/lib/python3.12/site-packages/sphinx/ext/viewcode.py", line 290, in collect_pages
+ lines[start])
~~~~~^^^^^^^
IndexError: list index out of range
Running into the same issue myself. I've managed to mitigate the issue by fixing Sphinx to version 7.2.6. The issue appears since 7.3.0, but confusingly this only happens in one of the projects inside the organization. All other doc build succeed, even with Sphinx 7.3.7
@Stausssi I tried this and got Theme error: UndefinedError("'style' is undefined")
error, see https://github.com/readthedocs/readthedocs.org/issues/10279
I have the same issue. It is observed after pydantic migration (from 1.10.2 to 2.1.1).
Instalation of autodoc-pydantic sphinx extension helps for me.
@jjacekk which version of autodoc_pydantic are you using? I have 2.1.0 and it's still failing with list index out of range
@BrandonLiang Some of my packages: autodoc-pydantic 2.0.1 pydantic 2.5.2 pydantic_core 2.14.5 pydantic-settings 2.0.2 Sphinx 5.2.3 sphinx-autoapi 2.1.1 sphinx-data-viewer 0.1.2 sphinx-rtd-theme 1.0.0 sphinxcontrib-applehelp 1.0.2 sphinxcontrib-devhelp 1.0.2 sphinxcontrib-htmlhelp 2.0.0 sphinxcontrib-jquery 4.1 sphinxcontrib-jsmath 1.0.1 sphinxcontrib-needs 0.7.9 sphinxcontrib-plantuml 0.24 sphinxcontrib-programoutput 0.17 sphinxcontrib-qthelp 1.0.3 sphinxcontrib-serializinghtml 1.1.5 sphinxcontrib-xlsxtable 1.0.0
@jjacekk / @BrandonLiang what build command are you using? Can you link to the documentation it is for?
A
Describe the bug
When attempting to build the docs for our project at https://github.com/aiproteomics/aiproteomics we get an exception:
This happens when running
make coverage doctest html
.The full output is here:
How to Reproduce
The command was
make coverage doctest html
. run in the docs/ directory of our repo: https://github.com/aiproteomics/aiproteomicsIt is possible to cause this with
make html
Environment Information
text Platform: darwin; (macOS-10.16-x86_64-i386-64bit) Python version: 3.9.15 (main, Nov 24 2022, 08:29:02) [Clang 14.0.6 ]) Python implementation: CPython Sphinx version: 5.3.0 Docutils version: 0.17.1 Jinja2 version: 3.1.2
Sphinx extensions
No response
Additional context
No response