About this docker image
This image was made for build sphinx documents. Target CI-software is gitlab-ci.
Some useful sphinxcontrib packages and theme are included.
If you need latex/pdf output, use tsgkadot/sphinx-plantuml:tex image.(Size is too big!)
docker run --rm -v `pwd`:/tmp/sphinx --name sphinx sphinx-plantuml sphinx-build -b html /tmp/sphinx/source /tmp/sphinx/build
Sample .gitlab.yml is bellow.
image: tsgkadot/sphinx-plantuml:latest stages: - build pages: stage: build script: - pip install -r requirements.txt -U - sphinx-build -b html ./source public artifacts: expire_in: 1 week paths: - public tags: - docker
- Tag: alpine python:3.5.2-alpine(Official image)
additional installed package
- sphinx 1.5.0
- sphinxcontrib-blockdiag 1.5.5
- sphinxcontrib-actdiag 0.8.5
- sphinxcontrib-nwdiag 0.9.5
- sphinxcontrib-seqdiag 0.8.5
- sphinxcontrib-plantuml 0.8.1
- java (for plantuml)
- graphviz (for plantuml)
- platnuml (Version 8050)
- git (#1)
Nice bootstrap / Material Design themes are included.
|sphinx_materialdesign_theme||0.2.1||material design theme|
These theme's demo sites are below.
Installe location is below.
It looks like since the upgrade to Python 3.6 Sphinx in this image is using the
appdirs package in version 1.4.2. Unfortunately that one is incompatible with Py 3.6, and it needs upgrading to 1.4.3.
For this reason my current GitLab CI jobs are failing. Should be an easy fix to get it back into working condition.
Cheers for the good job!
Unfortunately since the last change of the image my builds on Gitlab-CI keep failing.
I've been using previously
make for the build. That's easy enough to work around if not available any more. However, the main problem is that from my Sphinx
conf.py I'm calling
git with the
subprocess module to extract some version information to generate into the output. and I keep getting this exception:
File "/usr/local/lib/python3.5/subprocess.py", line 1544, in _execute_child
raise child_exception_type(errno_num, err_msg)
FileNotFoundError: [Errno 2] No such file or directory: 'git'
Any ideas on what's wrong, or what path
git should be in now?
Otherwise: You've done a fine job!