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.

Sign up for GitHub

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

Jump to bottom

Build Failed. TypeError: 'generator' object is not subscriptable #8616

Closed
GilimkhanovDenis opened this issue Oct 26, 2021 · 22 comments
Closed

Build Failed. TypeError: 'generator' object is not subscriptable #8616

GilimkhanovDenis opened this issue Oct 26, 2021 · 22 comments
Labels
Support Support question

Comments

@GilimkhanovDenis
Copy link

GilimkhanovDenis commented Oct 26, 2021 •
edited by astrojuanlu
Loading

Update from @astrojuanlu: see this comment for a workaround for this issue, our blog for a more detailed explanation, and this comment for current status of this issue

Success Build: https://readthedocs.org/projects/diadocsdk-1c/builds/15092197/
Failed Build: https://readthedocs.org/projects/diadocsdk-1c/builds/15095749/

It's the same commit

What is changed during 8 hours ?
What can I do for successful build?

building [html]: targets for 402 source files that are out of date
updating environment: 402 added, 0 changed, 0 removed
reading sources... [  0%] ComObjects/AcceptanceCertificateBuyerContent
reading sources... [  0%] ComObjects/AcceptanceCertificateContent
reading sources... [  0%] ComObjects/AcceptanceCertificateItem
reading sources... [  0%] ComObjects/AcceptanceCertificateSellerContent

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/cmd/build.py", line 304, in build_main
    app.build(args.force_all, filenames)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/application.py", line 341, in build
    self.builder.build_update()
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 347, in build_update
    len(to_build))
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 360, in build
    updated_docnames = set(self.read())
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 468, in read
    self._read_serial(docnames)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 490, in _read_serial
    self.read_doc(docname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/builders/__init__.py", line 534, in read_doc
    doctree = read_doc(self.app, self.env, self.env.doc2path(docname))
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/io.py", line 318, in read_doc
    pub.publish()
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/docutils/core.py", line 219, in publish
    self.apply_transforms()
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/docutils/core.py", line 200, in apply_transforms
    self.document.transformer.apply_transforms()
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/transforms/__init__.py", line 90, in apply_transforms
    Transformer.apply_transforms(self)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/docutils/transforms/__init__.py", line 171, in apply_transforms
    transform.apply(**kwargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/transforms/references.py", line 38, in apply
    domain.process_doc(self.env, self.env.docname, self.document)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/domains/std.py", line 586, in process_doc
    self.note_labels(env, docname, document)
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/domains/std.py", line 638, in note_labels
    n = node.traverse(addnodes.toctree)[0]
TypeError: 'generator' object is not subscriptable

Exception occurred:
  File "/home/docs/checkouts/readthedocs.org/user_builds/diadocsdk-1c/envs/dev/lib/python3.7/site-packages/sphinx/domains/std.py", line 638, in note_labels
    n = node.traverse(addnodes.toctree)[0]
TypeError: 'generator' object is not subscriptable
@humitos
Copy link
Member

humitos commented Oct 26, 2021

The version of docutils is not pinned and a new version was released.

The build that passed installed docutils-0.17.1-py2.py3-none-any.whl and the one that failed, installed docutils-0.18-py2.py3-none-any.whl

@humitos humitos added the Support Support question label Oct 26, 2021
@GilimkhanovDenis
Copy link
Author

@humitos thank you

@astrojuanlu
Copy link
Contributor

astrojuanlu commented Oct 26, 2021 •
edited
Loading

For future readers, the solution for this problem is to pin docutils<0.18 in your requirements.txt file, and have a .readthedocs.yaml file with these contents:

version: 2

python:
   install:
   - requirements: docs/requirements.txt

More information in our docs. See also our page on reproducible builds to better understand how to use requirements files on Read the Docs.

@JoepVanlier JoepVanlier mentioned this issue Oct 26, 2021
Merged
@astrojuanlu astrojuanlu mentioned this issue Oct 26, 2021
Closed
BrianJKoopman added a commit to simonsobs/socs that referenced this issue Oct 26, 2021
@BrianJKoopman
Pin docutils and add readthedocs config file
1bbc008 
A recent update in docutils breaks builds on readthedocs. This is the suggested
work around from readthedocs [1].

[1] - readthedocs/readthedocs.org#8616
@BrianJKoopman BrianJKoopman mentioned this issue Oct 26, 2021
Merged
7 tasks
adswa added a commit to datalad/datalad-osf that referenced this issue Oct 27, 2021
@adswa
CI: Fix readthedocs build
38a4375 
According to readthedocs/readthedocs.org#8616
@adswa adswa mentioned this issue Oct 27, 2021
Merged
adswa added a commit to datalad-handbook/book that referenced this issue Oct 27, 2021
@adswa
CI: Fix readthedocs build
c9ffb99 
According to readthedocs/readthedocs.org#8616
@adswa adswa mentioned this issue Oct 27, 2021
Merged
@astrojuanlu astrojuanlu mentioned this issue Oct 27, 2021
Closed
@astrojuanlu
Copy link
Contributor

Great summary originally posted by @joshuacwnewton in sphinx-doc/sphinx#9783 (comment):

We've run into this issue too for several projects. Here's a summary of the problem:

The solution we settled on was to make sure we explicitly specified a more recent version of Sphinx in our RTD requirements. Please refer to RTD's "Reproducible Builds" page (and specifically the pinning dependencies section) for more information on RTD's recommendations here.

@joshuacwnewton
Copy link

joshuacwnewton commented Oct 27, 2021 •
edited
Loading

Quick addendum:

  • If your project pins the version of sphinx using extras_require keyword in your setup.py, and
  • In RTD you're installing your project via the python keyword of your .readthedocs.yaml config file

Then you can also fix the problem by making sure you set extra_requirements in your RTD config file.

I've seen this trip up projects where folks were already pinning Sphinx, only to find out that RTD wasn't picking up those extra requirements.

@cirospat cirospat mentioned this issue Oct 27, 2021
Closed
@astrojuanlu astrojuanlu mentioned this issue Oct 27, 2021
Closed
@ylecornec ylecornec mentioned this issue Oct 27, 2021
Merged
This was referenced Oct 27, 2021
Merged
Merged
Merged
davidbeckingsale added a commit to LLNL/Umpire that referenced this issue Oct 27, 2021
@davidbeckingsale
Fix readthedocs build by pinning docutils version
b3a31a1 
Fix issue where Sphinx doesn't work with docutils 0.18 by specifying a
version constraint in docs/requirements.txt. More details:
readthedocs/readthedocs.org#8616
@davidbeckingsale davidbeckingsale mentioned this issue Oct 27, 2021
Merged
davidbeckingsale added a commit to LLNL/Umpire that referenced this issue Oct 27, 2021
@davidbeckingsale
Fix readthedocs build by pinning docutils version
7a57829 
Fix issue where Sphinx doesn't work with docutils 0.18 by specifying a
version constraint in docs/requirements.txt. More details:
readthedocs/readthedocs.org#8616
@rstoneback rstoneback mentioned this issue Oct 27, 2021
Merged
16 tasks
BrianJKoopman added a commit to simonsobs/socs that referenced this issue Oct 27, 2021
@BrianJKoopman
Pin docutils and add readthedocs config file
6f6301e 
A recent update in docutils breaks builds on readthedocs. This is the suggested
work around from readthedocs [1].

[1] - readthedocs/readthedocs.org#8616
@terrencetec terrencetec mentioned this issue Oct 28, 2021
Closed
@danielmitterdorfer danielmitterdorfer mentioned this issue Oct 28, 2021
Merged
jeabakker added a commit to jeabakker/Elgg that referenced this issue Oct 28, 2021
@jeabakker
chore(docs): lock docutils so RTD builds succeed
fec853b 
ref readthedocs/readthedocs.org#8616
This was referenced Nov 10, 2021
Merged
Merged
wol-soft added a commit to wol-soft/php-json-schema-model-generator that referenced this issue Nov 11, 2021
@wol-soft
Fix docs build (compare readthedocs/readthedocs.org#8616)
fc956f9
@bednar bednar mentioned this issue Nov 11, 2021
Merged
4 tasks
atrisovic added a commit to atrisovic/pyDataverse that referenced this issue Nov 11, 2021
@atrisovic
Pin dependencies for build issue
30b51b4 
See readthedocs/readthedocs.org#8616
@paulromano paulromano mentioned this issue Nov 11, 2021
Merged
@the-greenman the-greenman mentioned this issue Nov 12, 2021
Closed
@DerWeh DerWeh mentioned this issue Nov 12, 2021
Merged
zuo added a commit to zuo/unittest_expander that referenced this issue Nov 12, 2021
@zuo
Added docs/rtd-pinned-requirements.txt to pin docutils<0.18
a50dba2 
(see: readthedocs/readthedocs.org#8616)
philipstarkey added a commit to philipstarkey/monashspa that referenced this issue Nov 13, 2021
@philipstarkey
Add temporary fix for readthedocs/readthedocs.org#8616
7769b9e
@simonw simonw mentioned this issue Nov 14, 2021
Closed
markwj added a commit to openvehicles/Open-Vehicle-Monitoring-System-3 that referenced this issue Nov 15, 2021
@markwj
docutils<0.18 for readthedocs/readthedocs.org#8616 (comment)
6322cd4
@luu-alex luu-alex mentioned this issue Nov 16, 2021
Merged
@rick-masters rick-masters mentioned this issue Nov 16, 2021
Closed
@RogerHaase RogerHaase mentioned this issue Nov 17, 2021
Closed
Mayitzin added a commit to Mayitzin/ahrs that referenced this issue Nov 18, 2021
@Mayitzin
Cap version of docutils to avoid bug building the documentation in rtd.
7c5c272 
The newest version of docutils clashes with the built system in readthedocs. An older version is required for it to work. See readthedocs/readthedocs.org#8616
@astrojuanlu
Copy link
Contributor

Update: Sphinx 1.8.6 was released this week, and it pins docutils to <0.18 (thanks @tk0miya ❤️)

However, users of old pip versions (for example on Python 2) might not benefit from this, and will need to pin docutils themselves anyway. Otherwise, they will still observe the error, plus this warning on the logs:

ERROR: pip's legacy dependency resolver does not consider dependency conflicts when selecting packages. This behaviour is the source of the following dependency conflicts.
sphinx 1.8.6 requires docutils<0.18,>=0.11, but you'll have docutils 0.18 which is incompatible.

@gmilde
Copy link

gmilde commented Nov 20, 2021 via email

@astrojuanlu
Copy link
Contributor

Thanks @gmilde , looking into this 👍🏽

@astrojuanlu
Copy link
Contributor

@gmilde I confirm that docutils 0.18.1b1 does not exhibit the 'generator' object has no attribute '__getitem__' (or variations of it) anymore 👍🏽

I was testing with a fork of the project where I originally detected this. I may delete the project at any time.

Amending diff: astrojuanlu/phpunit-documentation-english@968e3d2

duartegalvao pushed a commit to duartegalvao/indico that referenced this issue Dec 6, 2021
@ThiefMaster @duartegalvao
Fix RTD build
dbaa350 
readthedocs/readthedocs.org#8616
duartegalvao pushed a commit to duartegalvao/indico that referenced this issue Dec 7, 2021
@ThiefMaster @duartegalvao
Fix RTD build
0ebd8af 
readthedocs/readthedocs.org#8616
Jakob-Lass added a commit to MJOLNIRPackage/MJOLNIR that referenced this issue Dec 15, 2021
@Jakob-Lass
Remove old commissioning folder
df387bb 
Add readthedocs.yaml
Add requirements with docutils<0.18 (described in
 readthedocs/readthedocs.org#8616)
@astrojuanlu astrojuanlu unpinned this issue Dec 21, 2021
white238 added a commit to LLNL/ATS that referenced this issue Feb 17, 2022
@white238
add workaround for docutils problem readthedocs/readthedocs.org#8616
68aa996
dawson6 pushed a commit to LLNL/ATS that referenced this issue Feb 17, 2022
@white238
link docs and add badge to readme (#71)
f51c218 
* link docs and add badge to readme

* add workaround for docutils problem readthedocs/readthedocs.org#8616

* update copyright

* move toc to intro page

* delete old index before moving intro in its place

* move intro into index's place

* fix path

* fix another path
0xtobit pushed a commit to braintree/braintree_python that referenced this issue Apr 19, 2022
@braintreeps
Fix failing readthedocs builds
91e4a98 
See: readthedocs/readthedocs.org#8616
zuo added a commit to zuo/unittest_expander that referenced this issue Mar 18, 2023
@zuo
Removed docs/rtd-pinned-requirements.txt...
22ef0db 
...as pinning `docutils<0.18` seems no longer necessary (see:
readthedocs/readthedocs.org#8616).
@ynikitenko ynikitenko mentioned this issue Apr 10, 2023
Closed
jarrodchesney pushed a commit to Synerty/synerty-peek that referenced this issue Nov 27, 2023
@llouislu
PEEK-1326 Added solution to fix readthedocs.org fail
8f3cfa7 
Upstream cause is at
readthedocs/readthedocs.org#8616 (comment)

The solution is at
readthedocs/readthedocs.org#8616 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Support Support question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
9 participants
@coleifer @humitos @astrojuanlu @anitagraser @gmilde @agjohnson @gwilku @joshuacwnewton @GilimkhanovDenis