rsyslog/rsyslog_doc_gen image: new version of Sphinx released

[deoren]

Just a FYI. From the changelog:

Release 1.6.7 (released Feb 04, 2018)

Bugs fixed

#1922: html search: Upper characters problem in French
#4412: Updated jQuery version from 3.1.0 to 3.2.1
#4438: math: math with labels with whitespace cause html error
#2437: make full reference for classes, aliased with “alias of”
#4434: pure numbers as link targets produce warning
#4477: Build fails after building specific files
#4449: apidoc: include “empty” packages that contain modules
#3917: citation labels are tranformed to ellipsis
#4501: graphviz: epub3 validation error caused if graph is not clickable
#4514: graphviz: workaround for wrong map ID which graphviz generates
#4525: autosectionlabel does not support parallel build
#3953: Do not raise warning when there is a working intersphinx inventory
#4487: math: ValueError is raised on parallel build. Thanks to jschueller.
#2372: autosummary: invalid signatures are shown for type annotated functions
#3942: html: table is not aligned to center even if :align: center

Do you prefer that tickets re Sphinx updates be posted here or in the rsyslog/rsyslog-doc project?

[rgerhards]

Actually, I think this is primarily for the doc project. It looks, though, like the doc container has not yet picked this up. I rebuilt it today for some of the changes re the theme and it still seems to be the old code. Is more than pip install sphinx required in order to get it on a fresh install?

[deoren]

@rgerhards: Is more than pip install sphinx required in order to get it on a fresh install?

AFAIK, not if it's never been there before. If it is already installed you have to run pip install -U sphinx to upgrade it and its dependencies.

[rgerhards]

P Sent from phone, thus brief. Am 06.02.2018 16:17 schrieb "Deoren Moor" <[email protected]>: @rgerhards <https://github.com/rgerhards>: Is more than pip install sphinx required in order to get it on a fresh install? AFAIK, not if it's never been there before. If it is already installed you have to run pip install -U sphinx to upgrade it and its dependencies. In this context it is a fresh install..

[deoren]

@rgerhards: In this context it is a fresh install..

That's odd. I'm pretty sure that the container I built from the Dockerfile (https://github.com/rsyslog/rsyslog-doc/blob/master/tools/buildenv/Dockerfile) ended up with Sphinx 1.6.7 installed. I'll give it another try in a bit to confirm.

[deoren]

@rgerhards: Is more than pip install sphinx required in order to get it on a fresh install?

I tested using the latest Dockerfile from master and didn't have any problems building an image with Sphinx 1.6.7 and then generating fresh docs.

1. ubuntu@ubuntu-1604-virtual-machine:~/Desktop$ git clone https://github.com/rsyslog/rsyslog-doc

2. ubuntu@ubuntu-1604-virtual-machine:~/Desktop/rsyslog-doc/tools/buildenv$ sudo docker build -t doc-build:01 $PWD

3. ubuntu@ubuntu-1604-virtual-machine:~/Desktop/rsyslog-doc$ sudo docker run -ti -v $PWD:/rsyslog-doc doc-build:01

Snippet from output:

Running Sphinx v1.6.7

Detailed output:

Sending build context to Docker daemon  11.78kB
Step 1/13 : FROM	alpine:3.7
3.7: Pulling from library/alpine
ff3a5c916c92: Pull complete 
Digest: sha256:7df6db5aa61ae9480f52f0b3a06a140ab98d427f86d8d5de0bedab9b8df6b1c0
Status: Downloaded newer image for alpine:3.7
 ---> 3fd9065eaf02
Step 2/13 : LABEL	maintainer [email protected]
 ---> Running in 040ad43beff9
Removing intermediate container 040ad43beff9
 ---> 5563425eebf0
Step 3/13 : RUN	apk add --no-cache py-pip git
 ---> Running in 8e8245eea0ba
fetch http://dl-cdn.alpinelinux.org/alpine/v3.7/main/x86_64/APKINDEX.tar.gz
fetch http://dl-cdn.alpinelinux.org/alpine/v3.7/community/x86_64/APKINDEX.tar.gz
(1/17) Installing ca-certificates (20171114-r0)
(2/17) Installing libssh2 (1.8.0-r2)
(3/17) Installing libcurl (7.57.0-r0)
(4/17) Installing expat (2.2.5-r0)
(5/17) Installing pcre2 (10.30-r0)
(6/17) Installing git (2.15.0-r1)
(7/17) Installing libbz2 (1.0.6-r6)
(8/17) Installing libffi (3.2.1-r4)
(9/17) Installing gdbm (1.13-r1)
(10/17) Installing ncurses-terminfo-base (6.0_p20171125-r0)
(11/17) Installing ncurses-terminfo (6.0_p20171125-r0)
(12/17) Installing ncurses-libs (6.0_p20171125-r0)
(13/17) Installing readline (7.0.003-r0)
(14/17) Installing sqlite-libs (3.21.0-r0)
(15/17) Installing python2 (2.7.14-r2)
(16/17) Installing py-setuptools (33.1.1-r1)
(17/17) Installing py2-pip (9.0.1-r1)
Executing busybox-1.27.2-r7.trigger
Executing ca-certificates-20171114-r0.trigger
OK: 76 MiB in 28 packages
Removing intermediate container 8e8245eea0ba
 ---> f35f6b908ff6
Step 4/13 : RUN	pip install sphinx sphinx-better-theme
 ---> Running in ad0c6272a75e
Collecting sphinx
  Downloading Sphinx-1.6.7-py2.py3-none-any.whl (1.9MB)
Collecting sphinx-better-theme
  Downloading sphinx-better-theme-0.13.tar.gz
Collecting snowballstemmer>=1.1 (from sphinx)
  Downloading snowballstemmer-1.2.1-py2.py3-none-any.whl (64kB)
Collecting alabaster<0.8,>=0.7 (from sphinx)
  Downloading alabaster-0.7.10-py2.py3-none-any.whl
Collecting Jinja2>=2.3 (from sphinx)
  Downloading Jinja2-2.10-py2.py3-none-any.whl (126kB)
Collecting imagesize (from sphinx)
  Downloading imagesize-0.7.1-py2.py3-none-any.whl
Requirement already satisfied: setuptools in /usr/lib/python2.7/site-packages (from sphinx)
Collecting babel!=2.0,>=1.3 (from sphinx)
  Downloading Babel-2.5.3-py2.py3-none-any.whl (6.8MB)
Collecting Pygments>=2.0 (from sphinx)
  Downloading Pygments-2.2.0-py2.py3-none-any.whl (841kB)
Collecting docutils>=0.11 (from sphinx)
  Downloading docutils-0.14-py2-none-any.whl (543kB)
Collecting requests>=2.0.0 (from sphinx)
  Downloading requests-2.18.4-py2.py3-none-any.whl (88kB)
Collecting six>=1.5 (from sphinx)
  Downloading six-1.11.0-py2.py3-none-any.whl
Collecting typing; python_version < "3.5" (from sphinx)
  Downloading typing-3.6.4-py2-none-any.whl
Collecting sphinxcontrib-websupport (from sphinx)
  Downloading sphinxcontrib_websupport-1.0.1-py2.py3-none-any.whl
Collecting MarkupSafe>=0.23 (from Jinja2>=2.3->sphinx)
  Downloading MarkupSafe-1.0.tar.gz
Collecting pytz>=0a (from babel!=2.0,>=1.3->sphinx)
  Downloading pytz-2017.3-py2.py3-none-any.whl (511kB)
Collecting chardet<3.1.0,>=3.0.2 (from requests>=2.0.0->sphinx)
  Downloading chardet-3.0.4-py2.py3-none-any.whl (133kB)
Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx)
  Downloading certifi-2018.1.18-py2.py3-none-any.whl (151kB)
Collecting urllib3<1.23,>=1.21.1 (from requests>=2.0.0->sphinx)
  Downloading urllib3-1.22-py2.py3-none-any.whl (132kB)
Collecting idna<2.7,>=2.5 (from requests>=2.0.0->sphinx)
  Downloading idna-2.6-py2.py3-none-any.whl (56kB)
Installing collected packages: snowballstemmer, alabaster, MarkupSafe, Jinja2, imagesize, pytz, babel, Pygments, docutils, chardet, certifi, urllib3, idna, requests, six, typing, sphinxcontrib-websupport, sphinx, sphinx-better-theme
  Running setup.py install for MarkupSafe: started
    Running setup.py install for MarkupSafe: finished with status 'done'
  Running setup.py install for sphinx-better-theme: started
    Running setup.py install for sphinx-better-theme: finished with status 'done'
Successfully installed Jinja2-2.10 MarkupSafe-1.0 Pygments-2.2.0 alabaster-0.7.10 babel-2.5.3 certifi-2018.1.18 chardet-3.0.4 docutils-0.14 idna-2.6 imagesize-0.7.1 pytz-2017.3 requests-2.18.4 six-1.11.0 snowballstemmer-1.2.1 sphinx-1.6.7 sphinx-better-theme-0.13 sphinxcontrib-websupport-1.0.1 typing-3.6.4 urllib3-1.22
Removing intermediate container ad0c6272a75e
 ---> dd9da83d0dcb
Step 5/13 : RUN	adduser -s /bin/ash -D rsyslog rsyslog 	&& echo "rsyslog ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
 ---> Running in 1dee8981771e
Removing intermediate container 1dee8981771e
 ---> 173b36ce3a43
Step 6/13 : WORKDIR	/home/appliance
Removing intermediate container b10030401cce
 ---> b847bf59049d
Step 7/13 : CMD	["build-doc"]
 ---> Running in 30c3c5134c57
Removing intermediate container 30c3c5134c57
 ---> 09b40432d10a
Step 8/13 : ENTRYPOINT ["/home/appliance/starter.sh"]
 ---> Running in 8a565ccb1d1e
Removing intermediate container 8a565ccb1d1e
 ---> 791c38638a1a
Step 9/13 : VOLUME	/rsyslog-doc
 ---> Running in 1553ecf3a2d6
Removing intermediate container 1553ecf3a2d6
 ---> 9bb1f7553c43
Step 10/13 : RUN	chmod a+w /rsyslog-doc
 ---> Running in 7d5032b4bc7e
Removing intermediate container 7d5032b4bc7e
 ---> 6187ece231bd
Step 11/13 : ENV	BRANCH="master" 	FORMAT="html" 	STRICT="-n -W"
 ---> Running in 87a0799c85dc
Removing intermediate container 87a0799c85dc
 ---> 4df0615850c3
Step 12/13 : COPY	starter.sh ./
 ---> a1ff47c803f5
Step 13/13 : COPY	tools/* ./tools/
 ---> 07d61fdc5960
Successfully built 07d61fdc5960
Successfully tagged doc-build:01

ubuntu@ubuntu-1604-virtual-machine:~/Desktop/rsyslog-doc$ sudo docker run -ti -v $PWD:/rsyslog-doc doc-build:01

Running Sphinx v1.6.7
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 254 source files that are out of date
updating environment: 254 added, 0 changed, 0 removed
reading sources... [100%] whitepapers/syslog_protocol                                                                                                                                                       
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] whitepapers/syslog_protocol                                                                                                                                                        
generating indices... genindex
writing additional pages... search
copying images... [100%] configuration/modules/module_workflow.png                                                                                                                                          
copying downloadable files... [100%] configuration/rsyslog-example.conf                                                                                                                                     
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded.