TYPO3-docker-boilerplate icon indicating copy to clipboard operation
TYPO3-docker-boilerplate copied to clipboard

Documentation container

Open elmar-hinz opened this issue 8 years ago • 8 comments

Daniel has created a docker to generate T3 sphinx documentation.

https://github.com/DanielSiepmann/t3-sphinx

I think this would complete TYPO3-docker-boilerplate, if we could render the documentation without additional configuration to HTML, PDF and JSON. (JSON is the format needed by the extension restdoc to render Sphinx to TYPO3 pages.)

As there is already a Makefile:

  • make html extension_key
  • make pdf extension_key
  • make json extension_key
  • make doc extension_key

(doc for html + pdf)

or

  • make extension_key html
  • make extension_key pdf
  • make extension_key json
  • make extension_key doc

elmar-hinz avatar Apr 14 '16 19:04 elmar-hinz

Currently the Docker setup doesn't provide the dependencies for PDF. And is only tested with html. But I think that should be enough at the beginning and can easily be extended.

I've made it available via the hub (https://hub.docker.com/r/danielsiepmann/t3-sphinx/). That way it should be possible to add it via docker-compose.

DanielSiepmann avatar Apr 14 '16 19:04 DanielSiepmann

IMHO beautiful PDF uses Latex, many, many files.

Simple rst2pdf may be a start.

elmar-hinz avatar Apr 14 '16 19:04 elmar-hinz

From Martin Bless: LaTeX/PDF

https://github.com/marble/Vagrant.SphinxBase/blob/master/provision.sh

https://git.typo3.org/Teams/Documentation.git

elmar-hinz avatar Apr 15 '16 07:04 elmar-hinz

I'll try to add it next week.

DanielSiepmann avatar Apr 15 '16 12:04 DanielSiepmann

We've also build a sphinx image some days/weeks ago and it's very minimalistic (63 MB). @PanadeEdu is using it for our sphinx documentation. https://hub.docker.com/r/webdevops/sphinx

mblaschke avatar Apr 17 '16 12:04 mblaschke

With 63MB is there already LaTeX inside?

elmar-hinz avatar Apr 17 '16 13:04 elmar-hinz

Nope, only sphinx currently

mblaschke avatar Apr 17 '16 13:04 mblaschke

Relates to #141

tbal avatar Jan 22 '17 18:01 tbal