From 284ea1f91157328d52db84441b32cbbd58ff792a Mon Sep 17 00:00:00 2001 From: gulliver Date: Thu, 5 Aug 2021 22:27:25 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3a61aff..3cb5543 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,19 @@ It contains a configuration for three different generators: ## mdbook and mdbook-epub -tbd more details on README.md in mdbook directory +tbd ## crowbook -tbd more details on README.md in crowbook directory +tbd ## sphinx -tbd more details on README.md in sphinx directory +tbd + +### sphinx html theme for wtf coop + +the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI. ## How to build @@ -56,13 +60,26 @@ Expected Output In the virtual environment install the following modules with pip: ````` - (py3-sphinx) $ pip install sphinx3 sphinxcontrib-plantuml myst_parser + (py3-sphinx) $ pip install sphinx3 sphinxcontrib-plantuml myst-parser `````` For generating the images from plantuml-sources it needs also [Plantuml](https://plantuml.com/). For pdf output the latex builder is used, so it needs also an installed latex and pdflatex. -## +### Running the document generation via make + +The top level directory contains a Makefile + +For generation with all tools use +````` +make all +````` + +For generation with single tool use: +````` +make mdbook [crowbook sphinx] +````` + ## Issues ### mdbook - rendering problem with current inputs @@ -73,5 +90,7 @@ mumble and mailto links are not rendered correctly tbd have an eye on all outputs ## TODO - -### unify Title and authors in the configurations +- [ ] complete wtf coop HTML theme +- [ ] add frontpage with wtf coop CI +- [ ] adapt generated pdf to WTF design +- [ ] unify Title and authors in the configurations