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

Sphinx 1.6.1 compatibility #39

Open
zegkljan opened this issue May 17, 2017 · 1 comment · May be fixed by #46
Open

Sphinx 1.6.1 compatibility #39

zegkljan opened this issue May 17, 2017 · 1 comment · May be fixed by #46

Comments

@zegkljan
Copy link

Yesterday, on May 16th, sphinx 1.6.1 was released. sphixcontrib-versioning does not work with that version of sphinx, since the StandaloneHTMLBuilder does not have the default_sidebars attribute anymore, so it fails on AttributeError:

=> Pre-running Sphinx to collect versions' master_doc and other info.
Running Sphinx v1.6.1
loading translations [cs]... done
loading pickled environment... not yet created

Exception occurred:
  File "/home/zegklitz/sandbox/sphinxversioning-env/lib/python3.5/site-packages/sphinxcontrib/versioning/sphinx_.py", line 60, in builder_inited
    app.config.html_sidebars['**'] = StandaloneHTMLBuilder.default_sidebars + ['versions.html']
AttributeError: type object 'StandaloneHTMLBuilder' has no attribute 'default_sidebars'
The full traceback has been saved in /tmp/sphinx-err-hnfq1qko.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://github.com/sphinx-doc/sphinx/issues>. Thanks!
Process Process-1:
Traceback (most recent call last):
  File "/usr/lib/python3.5/multiprocessing/process.py", line 249, in _bootstrap
    self.run()
  File "/usr/lib/python3.5/multiprocessing/process.py", line 93, in run
    self._target(*self._args, **self._kwargs)
  File "/home/zegklitz/sandbox/sphinxversioning-env/lib/python3.5/site-packages/sphinxcontrib/versioning/sphinx_.py", line 204, in _build
    raise SphinxError
sphinx.errors.SphinxError
=> sphinx-build failed for branch/tag: feature/sdgraph2
Failure.

There are probably more things that went off-rails, this is just the first one that comes up. It works with sphinx 1.5.6 just fine.

The best option would be to make it compatible with 1.6.1. But, fixing it or not, it would be wise to indicate with which sphinx versions does sphinxcontrib-versioning work. It took me quite a lot of digging in the sphinx files and changelogs until I found the source of the issue.

@Lingnik
Copy link

Lingnik commented Sep 22, 2017

#46

jwkaltz added a commit to openoereb/pyramid_oereb that referenced this issue Oct 29, 2018
…ib-versioning#39. Furthermore, remove external napoleon in travis, to be consistent with project Makefile
muggenhor added a commit to muggenhor/sphinxcontrib-versioning that referenced this issue Sep 12, 2019
StandaloneHTMLBuilder.default_sidebars was removed in sphinx ~1.6.

sphinx-doc/sphinx@e8e63b1

sphinx-contrib#39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants