Public | Automated Build

Last pushed: 9 months ago
Short Description
sphinx-plantuml-blockdiag
Full Description

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!)

日本語はこちら

Simple Usage

docker run --rm -v `pwd`:/tmp/sphinx --name sphinx sphinx-plantuml sphinx-build -b html /tmp/sphinx/source /tmp/sphinx/build

Gitlab-CI usage.

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

base image

  • 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

installed software

  • java (for plantuml)
  • graphviz (for plantuml)
  • platnuml (Version 8050)
  • git (#1)

installed theme

Nice bootstrap / Material Design themes are included.

theme version remarks
sphinxbootstrap4theme 0.5.0 Bootstrap theme
sphinx_materialdesign_theme 0.2.1 material design theme

These theme's demo sites are below.

plantuml location

  • /usr/local/plantuml/plantuml.jar
echo $PLANTUML

Installed Fonts

Installe location is below.

/usr/share/fonts/TakaoFonts/

Docker Pull Command
Owner
tsgkadot
Source Repository