HTML loomine dockeriga

[agoluberg]

Ma tegin praegu käsitsi läbi, aga tundub, et umbes selline värk võiks toimida. Vaata ka siia: https://gitlab.com/ddidier/docker-sphinx-doc

Kõigepealt juhendi järgi dockeri build.

Seejärel on vaja Makefile lisada lähtekoodi. Selle ma lasin sphinx-init skriptiga luua. Faili sisu on järgmine:

# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
SOURCEDIR     = .
BUILDDIR      = _build

# Put it first so that "make" without argument is like "make help".
help:
        @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
        @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

SPHINXPORT = 8000

livehtml:
        sphinx-autobuild -b html --host 0.0.0.0 --port $(SPHINXPORT) $(ALLSPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html"

Kui selline fail on olemas juurkaustas, siis saab html-i genereerida järgmiselt:

docker run -i -v /home/user/javadoc/:/doc -e USER_ID=$UID ddidier/sphinx-doc make html

Kus /home/user/javadoc on kaust, kuhu on kloonitud repo.

Võiks praeguse setup.py teha vastavalt ringi, et kutsutakse vajalikud käsud välja läbi dockeri. Too skript pannakse käima build masinas. Sealt kopeeritakse lihtsalt html vajalikku kohta (see jääb väljapoole skripti).