sphinxcontrib-versioning icon indicating copy to clipboard operation
sphinxcontrib-versioning copied to clipboard

support newer versions of sphinx

Open Lingnik opened this issue 8 years ago • 11 comments

StandaloneHTMLBuilder.default_sidebars was removed in sphinx ~1.6.

https://github.com/sphinx-doc/sphinx/commit/e8e63b1e9968abbaff46ddd7917d2b53cb505276#diff-c17608ed63bfe1714c6befb9d4201fee

Fixes #39

Lingnik avatar Sep 22 '17 16:09 Lingnik

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%) :arrow_down:
sphinxcontrib/versioning/lib.py 96.77% <0%> (-1.08%) :arrow_down:
sphinxcontrib/versioning/git.py 97.14% <0%> (-0.96%) :arrow_down:
sphinxcontrib/versioning/__init__.py 100% <0%> (ø) :arrow_up:
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.

codecov-io avatar Sep 22 '17 18:09 codecov-io

@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?

Lingnik avatar Sep 22 '17 19:09 Lingnik

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

Levi-Armstrong avatar Oct 04 '17 16:10 Levi-Armstrong

@Robpol86, please merge this PR :)

FraBle avatar Oct 10 '17 00:10 FraBle

@Robpol86, any updates on this PR?

FraBle avatar Dec 02 '17 00:12 FraBle

@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.

tmbo avatar Dec 09 '17 16:12 tmbo

@Robpol86 also affected by this one - please merge

mortenvp avatar Apr 30 '18 21:04 mortenvp

to install patched version

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

sizmailov avatar May 06 '18 09:05 sizmailov

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!

zhanghang1989 avatar May 07 '18 16:05 zhanghang1989

@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

sizmailov avatar May 13 '18 11:05 sizmailov

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.

ashb avatar May 24 '18 10:05 ashb