question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`make html` results in an error

See original GitHub issue

Describe the bug Running make html results in an error:

TypeError: __init__() got an unexpected keyword argument 'handle_io_errors'

Steps to reproduce

  1. clone this repo
  2. follow the instructions in the README:
    1. set up virtualenv inside the repo
    2. install libraries from requirements.txt and requirements-docs.txt
  3. try to generate html docs
  4. observe the failure

Expected behavior No exception occurs when I try to generate the html docs.

Debug logs This is my console log:

william@william-ThinkPad-T450s: ~/Documents/wpyoga$ git clone https://github.com/boto/boto3.git
Cloning into 'boto3'...
remote: Enumerating objects: 20941, done.
remote: Counting objects: 100% (1808/1808), done.
remote: Compressing objects: 100% (616/616), done.
remote: Total 20941 (delta 1228), reused 1746 (delta 1192), pack-reused 19133
Receiving objects: 100% (20941/20941), 7.84 MiB | 2.83 MiB/s, done.
Resolving deltas: 100% (15359/15359), done.
william@william-ThinkPad-T450s: ~/Documents/wpyoga$ cd boto3
william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3$ virtualenv venv
created virtual environment CPython3.8.10.final.0-64 in 392ms
  creator CPython3Posix(dest=/home/william/Documents/wpyoga/boto3/venv, clear=False, no_vcs_ignore=False, global=False)
  seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/william/.local/share/virtualenv)
    added seed packages: pip==21.1.3, setuptools==57.1.0, wheel==0.36.2
  activators BashActivator,CShellActivator,FishActivator,PowerShellActivator,PythonActivator,XonshActivator
william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3$ . venv/bin/activate
(venv) william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3$ pip3 install -r requirements.txt 
Obtaining botocore from git+git://github.com/boto/botocore.git@develop#egg=botocore (from -r requirements.txt (line 1))
  Cloning git://github.com/boto/botocore.git (to revision develop) to ./venv/src/botocore
  Running command git clone -q git://github.com/boto/botocore.git /home/william/Documents/wpyoga/boto3/venv/src/botocore
Obtaining jmespath from git+git://github.com/boto/jmespath.git@develop#egg=jmespath (from -r requirements.txt (line 2))
  Cloning git://github.com/boto/jmespath.git (to revision develop) to ./venv/src/jmespath
  Running command git clone -q git://github.com/boto/jmespath.git /home/william/Documents/wpyoga/boto3/venv/src/jmespath
  Running command git submodule update --init --recursive -q
Obtaining s3transfer from git+git://github.com/boto/s3transfer.git@develop#egg=s3transfer (from -r requirements.txt (line 3))
  Cloning git://github.com/boto/s3transfer.git (to revision develop) to ./venv/src/s3transfer
  Running command git clone -q git://github.com/boto/s3transfer.git /home/william/Documents/wpyoga/boto3/venv/src/s3transfer
Collecting nose==1.3.3
  Using cached nose-1.3.3-py3-none-any.whl
Collecting mock==1.3.0
  Using cached mock-1.3.0-py2.py3-none-any.whl (56 kB)
Collecting wheel==0.24.0
  Using cached wheel-0.24.0-py2.py3-none-any.whl (63 kB)
Collecting python-dateutil<3.0.0,>=2.1
  Using cached python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB)
Collecting urllib3<1.27,>=1.25.4
  Using cached urllib3-1.26.6-py2.py3-none-any.whl (138 kB)
Collecting six>=1.7
  Using cached six-1.16.0-py2.py3-none-any.whl (11 kB)
Collecting pbr>=0.11
  Using cached pbr-5.6.0-py2.py3-none-any.whl (111 kB)
Installing collected packages: six, urllib3, python-dateutil, jmespath, pbr, botocore, wheel, s3transfer, nose, mock
  Running setup.py develop for jmespath
  Running setup.py develop for botocore
  Attempting uninstall: wheel
    Found existing installation: wheel 0.36.2
    Uninstalling wheel-0.36.2:
      Successfully uninstalled wheel-0.36.2
  Running setup.py develop for s3transfer
Successfully installed botocore-1.21.2 jmespath-0.10.0 mock-1.3.0 nose-1.3.3 pbr-5.6.0 python-dateutil-2.8.2 s3transfer-0.5.0 six-1.16.0 urllib3-1.26.6 wheel-0.24.0
(venv) william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3$ pip3 install -e .
Obtaining file:///home/william/Documents/wpyoga/boto3
Requirement already satisfied: botocore<1.22.0,>=1.21.2 in ./venv/src/botocore (from boto3==1.18.2) (1.21.2)
Requirement already satisfied: jmespath<1.0.0,>=0.7.1 in ./venv/src/jmespath (from boto3==1.18.2) (0.10.0)
Requirement already satisfied: s3transfer<0.6.0,>=0.5.0 in ./venv/src/s3transfer (from boto3==1.18.2) (0.5.0)
Requirement already satisfied: python-dateutil<3.0.0,>=2.1 in ./venv/lib/python3.8/site-packages (from botocore<1.22.0,>=1.21.2->boto3==1.18.2) (2.8.2)
Requirement already satisfied: urllib3<1.27,>=1.25.4 in ./venv/lib/python3.8/site-packages (from botocore<1.22.0,>=1.21.2->boto3==1.18.2) (1.26.6)
Requirement already satisfied: six>=1.5 in ./venv/lib/python3.8/site-packages (from python-dateutil<3.0.0,>=2.1->botocore<1.22.0,>=1.21.2->boto3==1.18.2) (1.16.0)
Installing collected packages: boto3
  Running setup.py develop for boto3
Successfully installed boto3-1.18.2
(venv) william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3$ pip3 install -r requirements-docs.txt 
Obtaining botocore from git+git://github.com/boto/botocore.git@develop#egg=botocore (from -r requirements.txt (line 1))
  Updating ./venv/src/botocore clone (to revision develop)
  Running command git fetch -q --tags
  Running command git reset --hard -q c329fd23d3672b724a6dbd152f738de0b4d5a7ac
Obtaining jmespath from git+git://github.com/boto/jmespath.git@develop#egg=jmespath (from -r requirements.txt (line 2))
  Updating ./venv/src/jmespath clone (to revision develop)
  Running command git fetch -q --tags
  Running command git reset --hard -q 599b0f7ea650a60f7512233301e70ff8151de0f0
  Running command git submodule update --init --recursive -q
Obtaining s3transfer from git+git://github.com/boto/s3transfer.git@develop#egg=s3transfer (from -r requirements.txt (line 3))
  Updating ./venv/src/s3transfer clone (to revision develop)
  Running command git fetch -q --tags
  Running command git reset --hard -q 3bbb99fec6bf2ef3d71afffeb53311a8e6e57f08
Collecting markupsafe<2.0,>=1.1
  Using cached MarkupSafe-1.1.1-cp38-cp38-manylinux2010_x86_64.whl (32 kB)
Collecting jinja2<3.0,>=2.3
  Using cached Jinja2-2.11.3-py2.py3-none-any.whl (125 kB)
Collecting Sphinx<1.3,>=1.1.3
  Using cached Sphinx-1.2.3-py3-none-any.whl (1.2 MB)
Collecting guzzle_sphinx_theme<0.8,>=0.7.10
  Using cached guzzle_sphinx_theme-0.7.11-py3-none-any.whl
Requirement already satisfied: nose==1.3.3 in ./venv/lib/python3.8/site-packages (from -r requirements.txt (line 4)) (1.3.3)
Requirement already satisfied: mock==1.3.0 in ./venv/lib/python3.8/site-packages (from -r requirements.txt (line 5)) (1.3.0)
Requirement already satisfied: wheel==0.24.0 in ./venv/lib/python3.8/site-packages (from -r requirements.txt (line 6)) (0.24.0)
Requirement already satisfied: python-dateutil<3.0.0,>=2.1 in ./venv/lib/python3.8/site-packages (from botocore->-r requirements.txt (line 1)) (2.8.2)
Requirement already satisfied: urllib3<1.27,>=1.25.4 in ./venv/lib/python3.8/site-packages (from botocore->-r requirements.txt (line 1)) (1.26.6)
Requirement already satisfied: six>=1.7 in ./venv/lib/python3.8/site-packages (from mock==1.3.0->-r requirements.txt (line 5)) (1.16.0)
Requirement already satisfied: pbr>=0.11 in ./venv/lib/python3.8/site-packages (from mock==1.3.0->-r requirements.txt (line 5)) (5.6.0)
Collecting Pygments>=1.2
  Using cached Pygments-2.9.0-py3-none-any.whl (1.0 MB)
Collecting docutils>=0.10
  Using cached docutils-0.17.1-py2.py3-none-any.whl (575 kB)
Installing collected packages: markupsafe, Pygments, jmespath, jinja2, docutils, Sphinx, botocore, s3transfer, guzzle-sphinx-theme
  Attempting uninstall: jmespath
    Found existing installation: jmespath 0.10.0
    Uninstalling jmespath-0.10.0:
      Successfully uninstalled jmespath-0.10.0
  Running setup.py develop for jmespath
  Attempting uninstall: botocore
    Found existing installation: botocore 1.21.2
    Uninstalling botocore-1.21.2:
      Successfully uninstalled botocore-1.21.2
  Running setup.py develop for botocore
  Attempting uninstall: s3transfer
    Found existing installation: s3transfer 0.5.0
    Uninstalling s3transfer-0.5.0:
      Successfully uninstalled s3transfer-0.5.0
  Running setup.py develop for s3transfer
Successfully installed Pygments-2.9.0 Sphinx-1.2.3 botocore-1.21.2 docutils-0.17.1 guzzle-sphinx-theme-0.7.11 jinja2-2.11.3 jmespath-0.10.0 markupsafe-1.1.1 s3transfer-0.5.0
(venv) william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3$ cd docs
(venv) william@william-ThinkPad-T450s: ~/Documents/wpyoga/boto3/docs$ make html
sphinx-build -b html -d build/doctrees   source build/html
Making output directory...
Running Sphinx v1.2.3
/home/william/Documents/wpyoga/boto3/venv/lib/python3.8/site-packages/dateutil/parser/_parser.py:1207: UnknownTimezoneWarning: tzname PDT identified but not understood.  Pass `tzinfos` argument in order to correctly return a timezone-aware datetime.  In a future version, this will raise an exception.
  warnings.warn("tzname {tzname} identified but not understood.  "
loading pickled environment... failed: [Errno 2] No such file or directory: '/home/william/Documents/wpyoga/boto3/docs/build/doctrees/environment.pickle'
building [html]: targets for 347 source files that are out of date
updating environment: 347 added, 0 changed, 0 removed
reading sources... [  0%] guide/clients                                                                                                                                                                                                       
Exception occurred:
  File "/home/william/Documents/wpyoga/boto3/venv/lib/python3.8/site-packages/sphinx/environment.py", line 597, in __init__
    FileInput.__init__(self_, *args, **kwds)
TypeError: __init__() got an unexpected keyword argument 'handle_io_errors'
The full traceback has been saved in /tmp/sphinx-err-dau2ygne.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://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [Makefile:45: html] Error 1

This is the log file mentioned above: sphinx-err-dau2ygne.log

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:14 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
wpyogacommented, Jul 24, 2021

Oh, it actually needs a change to requirements-docs.txt in order to successfully do make html. I’ve created PR #2937 to fix this issue, it’s a trivial one-line addition. (I seem to lack the permission to reopen this issue)

1reaction
wpyogacommented, Jul 23, 2021

I just realized that in the previous log, the dependencies were installed to my home directory instead of inside the a virtual environment. I’ve redone the whole process, this time installing the dependencies inside a clean virtual environment. make html was also successful.

make-html-with-docutils-0.15.2-inside-virtualenv.log

Read more comments on GitHub >

github_iconTop Results From Across the Web

Debugging HTML - Learn web development | MDN
If you can't work out what every error message means, don't worry about it — a good idea is to try fixing a...
Read more >
How to check for errors in HTML ? - GeeksforGeeks
Validating our HTML: In order to make sure your html code is error free is by using html validation service by w3c. This...
Read more >
html - html5 validation error output - Stack Overflow
I've tried to validate my html5 document although I am getting some invalid markup errors. ... Some expert advise would be highly appreciated....
Read more >
HTML Report Output Error · Issue #613 · xunit/xunit - GitHub
There is an error in the message area of the HTML Report for test failures. The message area is not getting newlines in...
Read more >
Common HTML error codes - IU KB - Indiana University
Code Description Comment 100 Continue 101 Switching Protocols 200 OK Action completed successfully
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found