Build fails for release and forks, advice?

[tetov]

Hi!

I understand that the status of sphinxcontrib-versioning is a bit complicated, but I gather from reading from the issues and PRs and from looking at a few doc setups that people have this working. I was wondering if someone could help me with an issue I haven't found reported here on the repo.

Running sphinx-versioning build with the pypi version I get the error documented in issue #66 fixed in PR #69. However, running @z00sts' PR branch quits with a file not found error.

I've also tried @leokoppel's fork, but there it hangs after two runs of doc building and no files found in the reported path (/tmp/tmp*sphinxcontrib_versioning).

Anyone encountered something similar or could give some points towards getting this to work with compas-dev/compas?

General info

$ python --version
Python 3.6.9

$ pip freeze | grep -i sphinx
nbsphinx==0.4.3
Sphinx==2.2.0
sphinx-compas-theme==0.4.1
sphinxcontrib-applehelp==1.0.1
sphinxcontrib-devhelp==1.0.1
sphinxcontrib-htmlhelp==1.0.2
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
sphinxcontrib-versioning==2.2.1

$ git remote -v

origin          git@github.com:compas-dev/compas.git (fetch)
origin          git@github.com:compas-dev/compas.git (push)

Logs

$ pip install git+https://github.com/z00sts/sphinxcontrib-versioning.git@python3.6-import-error-workaround
$ sphinx-versioning -L build -i -r master docs /dist/docs
=> Gathering info about the remote git repository...
=> Getting list of all remote branches/tags...
=> Found: docs-pull-req footnote-fix master patch-1 pathlib_support quick-fix-clr-pythonnet sphinx-versioning update_robot worbit-patch-1 0.1.0 0.1.0-drx_numpy_callback 0.1.0-facenetwork_import 0.1.0-subd_ck_example_imports 0.1.0-viewer_glut_title_str 0.1.1 0.1.1-import_error_smoothing_cpp 0.1.1-import_problems_cpp_versions 0.1.1-leaves_after_embedding 0.1.1-rhino_utility_aliases 0.1.1-xfunc_callback_args 0.1.1_ga_bugfix v0.3.0 v0.3.1 v0.3.2 v0.3.3 v0.3.4 v0.3.5 v0.3.6 v0.4.0 v0.4.1 v0.4.10 v0.4.11 v0.4.12 v0.4.13 v0.4.14 v0.4.15 v0.4.16 v0.4.17 v0.4.18 v0.4.19 v0.4.2 v0.4.20 v0.4.21 v0.4.22 v0.4.23 v0.4.3 v0.4.4 v0.4.5 v0.4.6 v0.4.7 v0.4.8 v0.4.9 v0.5.0 v0.5.1 v0.5.2 v0.6.0 v0.6.1 v0.6.2 v0.7.0 v0.7.1 v0.7.2
=> With docs: docs-pull-req footnote-fix master patch-1 pathlib_support quick-fix-clr-pythonnet sphinx-versioning update_robot worbit-patch-1 v0.3.0 v0.3.1 v0.3.2 v0.3.3 v0.3.4 v0.3.5 v0.3.6 v0.4.0 v0.4.1 v0.4.10 v0.4.11 v0.4.12 v0.4.13 v0.4.14 v0.4.15 v0.4.16 v0.4.17 v0.4.18 v0.4.19 v0.4.2 v0.4.20 v0.4.21 v0.4.22 v0.4.23 v0.4.3 v0.4.4 v0.4.5 v0.4.6 v0.4.7 v0.4.8 v0.4.9 v0.5.0 v0.5.1 v0.5.2 v0.6.0 v0.6.1 v0.6.2 v0.7.0 v0.7.1 v0.7.2
=> Root ref is: master
=> Pre-running Sphinx to collect versions' master_doc and other info.
usage: sphinx-versioning [OPTIONS] SOURCEDIR OUTPUTDIR [FILENAMES...]
sphinx-versioning: error: cannot find files ['/tmp/tmpm9pm2hi8sphinxcontrib_versioning']
=> sphinx-build failed for branch/tag: master
Failure.

$ pip install git+https://github.com/leokoppel/sphinxcontrib-versioning
$ sphinx-versioning -L build -i -r master docs /dist/docs
=> Gathering info about the remote git repository...
=> Getting list of all remote branches/tags...

[...]
# Runs twice with Sphinx-warnings that we see with normal runs
[...]

copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 27 warnings.

The HTML pages are in ../../../../tmp/tmplibvh55lsphinxcontrib_versioning.

# Freezes

[h-olivier]

Hi Anton !

I encountered the same problem with the sphinxcontrib-versioning 2.2.1 from pypi. Even if I solved my problem in #66 I'm still stuck like you mentioned above.

[Stonesjtu]

Hi there, after digging around for 1 hour, I found a simple hack should work for this case.

sphinxcontrib-versioning/sphinxcontrib/versioning/sphinx_.py

Line 202 in 86a28dc

result = build_main(argv)

Change the argv to argv[1:].

Currently by default argv has three elements: sphinx-build, {SOURCE}, {TARGET}. But I suspect the new sphinx accepts only the last two, it will treat {TARGET} as filename option and check if it's really a file, which is a folder of course (Here's the logging line Not files).

[tetov]

Thanks! Going to test it out later today!

[Stonesjtu]

@tetov sorry for post a wrong solution, it's for another bug. BTW I encountered the same freezing bug too.

[Stonesjtu]

There are several things to make it work in my setting up.

1. add sphinxcontrib.versioning.sphinx_ to the extension list in conf.py
2. check-out support newer versions of sphinx #46 to fix the version mis-match issue.

It should work now.

[vancheese]

I've used fresh install from the main by following the two points above (I manually patched the sphinx.py) and then also also the ImportError: cannot import name 'build_main' fix
The program hangs after display

The HTML pages are in /tmp/tmpbuild directory

This error occurs with my real project and also with the tutorials simple example (https://sphinxcontrib-versioning.readthedocs.io/en/latest/tutorial.html#build-all-versions)

[Stonesjtu]

You can try add some log lines in these callbacks to see if this extension is registered correctly.

sphinxcontrib-versioning/sphinxcontrib/versioning/sphinx_.py

Line 47 in 86a28dc

def builder_inited(app):

sphinxcontrib-versioning/sphinxcontrib/versioning/sphinx_.py

Line 65 in 86a28dc

def env_updated(cls, app, env):

[GlitchyPSIX]

Any progress in this? I have this same problem.

[vancheese]

You can try add some log lines in these callbacks to see if this extension is registered correctly.

sphinxcontrib-versioning/sphinxcontrib/versioning/sphinx_.py

Line 47 in 86a28dc

def builder_inited(app):

sphinxcontrib-versioning/sphinxcontrib/versioning/sphinx_.py

Line 65 in 86a28dc

def env_updated(cls, app, env):

I added simple print commands to see if the two functions were called and finished.
Both function weren't called before the programm freezed

[Stonesjtu]

@vancheese Then the extension itself is not registered properly. Can you post the conf.py and command that failed?

[vancheese]

I've identified where the program freeze
In sphinx_.py in read_config, the program stops at

config = queue.get()

[GlitchyPSIX]

I've found that applying the patch from #46, then applying the argv[1:] fix and #66 makes the build system work and not stall anymore...

This may be because of sphinx version uncompatibility, because the fixes themselves end up stalling until #46 is applied

[paddy-hack]

I've been hit by this as well and tried to figure out what broke in which sphinx versions. I've used the Docker sphinx that I maintain for this and used the "quick-and-dirty" documentation from the tutorial for testing.

• for 1.6.5 to work, I had to apply support newer versions of sphinx #46
• for 1.7.0 to work, I had to apply Spinx 1.7+ ImportError workaround #69 as well as the argv[1:] fix mentioned above in addition to support newer versions of sphinx #46
• for 1.8.0 to work, I had to apply ConfigInject class incompatible with Sphinx 1.8 #57 in addition to the changes for 1.7.0 and 1.6.5
• for 2.0.0 to work, I had to apply ConfigInject class incompatible with Sphinx 1.8 #57 in addition to the changes for 1.7.0 and 1.6.5

Version 2.0.1 is the first version where I observed the hang/freeze. Apart from the sphinx version, there are no other differences between my Docker images for 2.0.0 and 2.0.1. The changes between those two don't provide any clue, to me at least, what might have triggered this.

[GlitchyPSIX]

@paddy-hack The changes I spoke about in my last comment work on sphinx 2.2.1 too