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

support newer versions of sphinx #46

Open
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
9 participants
@Lingnik

Lingnik commented Sep 22, 2017

StandaloneHTMLBuilder.default_sidebars was removed in sphinx ~1.6.

sphinx-doc/sphinx@e8e63b1#diff-c17608ed63bfe1714c6befb9d4201fee

Fixes #39

Lingnik added some commits Sep 22, 2017

dereference deprecated default_sidebars
StandaloneHTMLBuilder.default_sidebars was removed in sphinx ~1.6.

sphinx-doc/sphinx@e8e63b1#diff-c17608ed63bfe1714c6befb9d4201fee
backwards compatibility for default_sidebars
Tests appeared to start failing with my change. Realized that some test or users may be relying on the pre-1.6 default_sidebars behavior, threw in an EAFP.

@Lingnik Lingnik changed the title from dereference deprecated default_sidebars to support newer versions of sphinx Sep 22, 2017

@codecov-io

This comment has been minimized.

codecov-io commented Sep 22, 2017

Codecov Report

Merging #46 into master will decrease coverage by 0.55%.
The diff coverage is 50%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #46      +/-   ##
==========================================
- Coverage   99.01%   98.45%   -0.56%     
==========================================
  Files           9        8       -1     
  Lines         910      909       -1     
  Branches      178      176       -2     
==========================================
- Hits          901      895       -6     
- Misses          4        7       +3     
- Partials        5        7       +2
Impacted Files Coverage Δ
sphinxcontrib/versioning/sphinx_.py 98.63% <50%> (-1.37%) ⬇️
sphinxcontrib/versioning/lib.py 96.77% <0%> (-1.08%) ⬇️
sphinxcontrib/versioning/git.py 97.14% <0%> (-0.96%) ⬇️
sphinxcontrib/versioning/__init__.py 100% <0%> (ø) ⬆️
sphinxcontrib/__init__.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 920edec...d284a88. Read the comment docs.

@Lingnik

This comment has been minimized.

Lingnik commented Sep 22, 2017

@Robpol86 I can't grok how so many more tests in appveyor began failing with this change, and they seem unrelated to what I did. Also don't understand the coverage decrease for files other than sphinx_.py. Assigning to you anyways for merge?

@Levi-Armstrong

This comment has been minimized.

Levi-Armstrong commented Oct 4, 2017

👍 @Lingnik Thank you for the fix. I installed your branch and everything worked as expected.

@FraBle

This comment has been minimized.

FraBle commented Oct 10, 2017

@Robpol86, please merge this PR :)

@FraBle

This comment has been minimized.

FraBle commented Dec 2, 2017

@Robpol86, any updates on this PR?

@tmbo

This comment has been minimized.

tmbo commented Dec 9, 2017

@Robpol86 mind merging this one? If you don't maintain the repository anymore - please let someone else (e.g. one of the already existing contributors) take over.

@mortenvp

This comment has been minimized.

mortenvp commented Apr 30, 2018

@Robpol86 also affected by this one - please merge

@sizmailov

This comment has been minimized.

sizmailov commented May 6, 2018

to install patched version

pip install -U git+https://github.com/Lingnik/sphinxcontrib-versioning@Lingnik-patch-1
@zhanghang1989

This comment has been minimized.

zhanghang1989 commented May 7, 2018

Hi guys, is sphinx-versioning reinstalling/using the package in different commit? It seems that it only uses the master branch version. Therefore, the doc building often fails. Any comments? Thanks!

@sizmailov

This comment has been minimized.

sizmailov commented May 13, 2018

@zhanghang1989, sphinx-versioning checks out different commits, but does not perform install. If you have pure python project that should be enough to build documentation correctly.

In my project I have C++-extension module, so I need install to properly generate module API with autodoc.
I added several options to sphinx-versioning to actually trigger python setup.py install during doc generation, try the fork (it includes Lingnik's patch):

pip install -U git+https://github.com/sizmailov/sphinxcontrib-versioning@conditionally_run_setup_py
@ashb

This comment has been minimized.

ashb commented May 24, 2018

This change seems to remove entirely the default sidebars for me - I just end up with the versions in the side bar, but when building standalone I get a TOC and a few others.

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