sphinx-version-warning might require write permissions in /usr/local/lib

[aanm]

Exception occurred:
  File "/usr/local/lib/python3.6/site-packages/versionwarning/signals.py", line 66, in generate_versionwarning_data_json
    os.mkdir(data_path)
PermissionError: [Errno 13] Permission denied: '/usr/local/lib/python3.6/site-packages/versionwarning/_static/data'

@humitos let me know if you need more info

[humitos]

Yes. Please.

How are you installing it?
How are you executing it?
Is that local or at read the docs?

[aanm]

@humitos in a container.

If you want, the "easiest" way to replicate it is to do:

$ git clone --single-branch -b pr/add-warning-in-docs https://github.com/cilium/cilium.git
$ cd cilium
$ git reset --hard HEAD~1
$ make render-docs

you will see something like:

docker container run --rm -ti -u $(id -u):$(id -g aanm) -v $(pwd):/srv/ cilium/docs-builder /bin/bash -c 'make html'
! (sphinx-build -b spelling -d "_build/doctrees" "." "_build/spelling" -q -E  && touch check-build.ok) \
        | grep -v -e "tabs assets" -e "misspelled words"
/usr/local/lib/python3.6/site-packages/sphinx/application.py:402: RemovedInSphinx20Warning: app.info() is now deprecated. Use sphinx.util.logging instead.
  RemovedInSphinx20Warning)

Exception occurred:
  File "/usr/local/lib/python3.6/site-packages/versionwarning/signals.py", line 66, in generate_versionwarning_data_json
    os.mkdir(data_path)
PermissionError: [Errno 13] Permission denied: '/usr/local/lib/python3.6/site-packages/versionwarning/_static/data'
The full traceback has been saved in /tmp/sphinx-err-5wajn1p1.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!
make: *** [Makefile:56: check-build] Error 1
make: *** [Makefile:279: render-docs] Error 2

make render-docs will create a image with the dependencies already installed, after that it will run 'make html inside that container as a non-root user. That's where it fails.

[humitos]

I know the issue. I'll fix it this week. Thanks for the report

[aanm]

@humitos any updates ?

[humitos]

Hi! I had no time to take a look at this yet 😞. I'm sorry.

[humitos]

In case you want to play a little with this, the problem is at this line

https://github.com/humitos/sphinx-version-warning/blob/master/versionwarning/signals.py#L7

That path should be something writable by the user without root permissions. Currently, it's based on the signals.py file but it should probably based on the directory of where the user is executing the command.

[humitos]

In case you want to play a little with this,

... and propose a PR ;)

[pgajdos]

This happens to me too while building python-marshmallow (as non-root user).

[humitos]

@pgajdos how are you installing the extension? are you also using docker? are you building under Read the Docs?

[pgajdos]

I am installing it in minimal change root (automated build of python-marshmallow).
Here is the log.

[pgajdos]

(If I should perform some tests on the change root, let me know.)