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.

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

"tox -e narrativedocs" fails #10267

Closed
twisted-trac opened this issue Oct 12, 2021 · 2 comments
Closed

"tox -e narrativedocs" fails #10267

twisted-trac opened this issue Oct 12, 2021 · 2 comments

Comments

@twisted-trac
Copy link

twisted-trac commented Oct 12, 2021

cjwatson's avatar @cjwatson reported
Trac ID trac#10267
Type defect
Created 2021-10-12 13:11:44Z

I noticed this in a PR (https://github.com/twisted/twisted/pull/1149/checks?check_run_id=3870249057), but it doesn't seem to have anything to do with that PR:

Extension error (pydoctor.sphinx_ext.build_apidocs):
Handler <function on_builder_inited at 0x7f3f941a2280> for event 'builder-inited' threw an exception (exception: Exception while flattening:
  <pydoctor.templatewriter.summary.ClassIndexPage object at 0x7f3f8f332160>
  [Tag('html', children=['\n', '  ', Tag('head', children=['\n', '    ', Tag('title', children=['Something']), '\n', '    ', Tag('meta', attributes=OrderedDict([('http-equiv', 'Content-Type'), ('content', 'text/html;charset=utf-8')])), '\n', '    ', Tag('link', attributes=OrderedDict([('rel', 'stylesheet'), ('type', 'text/css'), ('href', 'bootstrap.min.css')])), '\n', '    ', Tag('link', attributes=OrderedDict([('rel', 'stylesheet'), ('type', 'text/css'), ('href', 'apidocs.css')])), '\n', '  ']), '\n', '  ', Tag('body', children=['\n', '    ', Tag('nav', attributes=OrderedDict([('class', 'navbar navbar-default')]), children=['\n', '      ', Tag('div', attributes=OrderedDict([('class', 'container')]), children=['\n', '        ', Tag('div', attributes=OrderedDict([('class', 'navbar-header navbar-brand')]), children=['\n', '          ', Tag('', children=['Some Project']), '\n', '          ', Tag('a', attributes=OrderedDict([('href', 'index.html')]), children=['API Documentation']), '\n', '        ']), '\n', '      ']), '\n', '    ']), '\n', '\n', '    ', Tag('div', attributes=OrderedDict([('class', 'container')]), children=['\n', '\n', '      ', Tag('div', attributes=OrderedDict([('class', 'page-header')]), children=['\n', '        ', Tag('h1', children=['Heading']), '\n', '        ', Tag('div', attributes=OrderedDict([('id', 'showPrivate')]), children=['\n', '          ', Tag('button', attributes=OrderedDict([('class', 'btn btn-link'), ('onclick', 'togglePrivate()')]), children=['Toggle Private API']), '\n', '        ']), '\n', '      ']), '\n', '\n', '      ', Tag('ul', attributes=OrderedDict([('id', 'summaryTree')]), children=['\n', '      ']), '\n', '\n', '    ']), '\n', '\n', '    ', Tag('script', attributes=OrderedDict([('src', 'pydoctor.js'), ('type', 'text/javascript')])), '\n', '\n', '  ']), '\n'])]
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/pydoctor/templates/summary.html", line 2, column 0, in "html"
  ['\n', '  ', Tag('head', children=['\n', '    ', Tag('title', children=['Something']), '\n', '    ', Tag('meta', attributes=OrderedDict([('http-equiv', 'Content-Type'), ('content', 'text/html;charset=utf-8')])), '\n', '    ', Tag('link', attributes=OrderedDict([('rel', 'stylesheet'), ('type', 'text/css'), ('href', 'bootstrap.min.css')])), '\n', '    ', Tag('link', attributes=OrderedDict([('rel', 'stylesheet'), ('type', 'text/css'), ('href', 'apidocs.css')])), '\n', '  ']), '\n', '  ', Tag('body', children=['\n', '    ', Tag('nav', attributes=OrderedDict([('class', 'navbar navbar-default')]), children=['\n', '      ', Tag('div', attributes=OrderedDict([('class', 'container')]), children=['\n', '        ', Tag('div', attributes=OrderedDict([('class', 'navbar-header navbar-brand')]), children=['\n', '          ', Tag('', children=['Some Project']), '\n', '          ', Tag('a', attributes=OrderedDict([('href', 'index.html')]), children=['API Documentation']), '\n', '        ']), '\n', '      ']), '\n', '    ']), '\n', '\n', '    ', Tag('div', attributes=OrderedDict([('class', 'container')]), children=['\n', '\n', '      ', Tag('div', attributes=OrderedDict([('class', 'page-header')]), children=['\n', '        ', Tag('h1', children=['Heading']), '\n', '        ', Tag('div', attributes=OrderedDict([('id', 'showPrivate')]), children=['\n', '          ', Tag('button', attributes=OrderedDict([('class', 'btn btn-link'), ('onclick', 'togglePrivate()')]), children=['Toggle Private API']), '\n', '        ']), '\n', '      ']), '\n', '\n', '      ', Tag('ul', attributes=OrderedDict([('id', 'summaryTree')]), children=['\n', '      ']), '\n', '\n', '    ']), '\n', '\n', '    ', Tag('script', attributes=OrderedDict([('src', 'pydoctor.js'), ('type', 'text/javascript')])), '\n', '\n', '  ']), '\n']
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/pydoctor/templates/summary.html", line 9, column 2, in "body"
  ['\n', '    ', Tag('nav', attributes=OrderedDict([('class', 'navbar navbar-default')]), children=['\n', '      ', Tag('div', attributes=OrderedDict([('class', 'container')]), children=['\n', '        ', Tag('div', attributes=OrderedDict([('class', 'navbar-header navbar-brand')]), children=['\n', '          ', Tag('', children=['Some Project']), '\n', '          ', Tag('a', attributes=OrderedDict([('href', 'index.html')]), children=['API Documentation']), '\n', '        ']), '\n', '      ']), '\n', '    ']), '\n', '\n', '    ', Tag('div', attributes=OrderedDict([('class', 'container')]), children=['\n', '\n', '      ', Tag('div', attributes=OrderedDict([('class', 'page-header')]), children=['\n', '        ', Tag('h1', children=['Heading']), '\n', '        ', Tag('div', attributes=OrderedDict([('id', 'showPrivate')]), children=['\n', '          ', Tag('button', attributes=OrderedDict([('class', 'btn btn-link'), ('onclick', 'togglePrivate()')]), children=['Toggle Private API']), '\n', '        ']), '\n', '      ']), '\n', '\n', '      ', Tag('ul', attributes=OrderedDict([('id', 'summaryTree')]), children=['\n', '      ']), '\n', '\n', '    ']), '\n', '\n', '    ', Tag('script', attributes=OrderedDict([('src', 'pydoctor.js'), ('type', 'text/javascript')])), '\n', '\n', '  ']
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/pydoctor/templates/summary.html", line 19, column 4, in "div"
  ['\n', '\n', '      ', Tag('div', attributes=OrderedDict([('class', 'page-header')]), children=['\n', '        ', Tag('h1', children=['Heading']), '\n', '        ', Tag('div', attributes=OrderedDict([('id', 'showPrivate')]), children=['\n', '          ', Tag('button', attributes=OrderedDict([('class', 'btn btn-link'), ('onclick', 'togglePrivate()')]), children=['Toggle Private API']), '\n', '        ']), '\n', '      ']), '\n', '\n', '      ', Tag('ul', attributes=OrderedDict([('id', 'summaryTree')]), children=['\n', '      ']), '\n', '\n', '    ']
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/pydoctor/templates/summary.html", line 28, column 6, in "ul"
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/twisted/web/_flatten.py", line 390, in _flattenTree
    element = next(stack[-1])
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/twisted/web/_flatten.py", line 304, in _flattenElement
    result = renderMethod(request, rootClone)
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/pydoctor/templatewriter/summary.py", line 127, in stuff
    for b, o in findRootClasses(self.system):
  File "/home/runner/work/twisted/twisted/.tox/narrativedocs/lib/python3.9/site-packages/pydoctor/templatewriter/summary.py", line 63, in findRootClasses
    cast(List[model.Class], roots.setdefault(n, [])).append(cls)
AttributeError: 'ZopeInterfaceClass' object has no attribute 'append'
)
ERROR: InvocationError for command /home/runner/work/twisted/twisted/.tox/narrativedocs/bin/sphinx-build -aW -b html -d /home/runner/work/twisted/twisted/docs/_build docs /home/runner/work/twisted/twisted/docs/_build/ (exited with code 2)

This seems to have been fixed in twisted/pydoctor@a28fdc3, which is part of pydoctor 21.9.0.

Searchable metadata
trac-id__10267 10267
type__defect defect
reporter__cjwatson cjwatson
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__closed closed
resolution__fixed fixed
component__pydoctor pydoctor
keywords__None None
time__1634044304738930 1634044304738930
changetime__1634097784194366 1634097784194366
version__None None
owner__None None

@twisted-trac
Copy link
Author

twisted-trac commented Oct 12, 2021

cjwatson's avatar @cjwatson commented

#1667

@twisted-trac
Copy link
Author

twisted-trac commented Oct 13, 2021

twm's avatar @twm set status to closed

This was reviewed and approved by graingert and adiroiban. I have merged per request on IRC.

A big thanks to everyone for fixing the build!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant