From af1449c5f41959674655bb352988409cfae15fc4 Mon Sep 17 00:00:00 2001 From: maehw Date: Sat, 23 Oct 2021 18:12:26 +0200 Subject: [PATCH] Add info how to checkout this repo properly --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0c04a5d..918394c 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,23 @@ This repo contains the sphinx configuration and the wtf theme for sphinx for the generation of the WTF handbook. this project is an experiment of how to generate html, epub and pdf -from the git repository for the WTF Handbook. +from the git repository for the WTF handbook. The handbuch sources are included as git submodule. # sphinx html theme for wtf coop -the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI. +the sphinx build uses an adapted sphinx theme for the WTF cooperatives CI. # How to build +### Checkout with submodules + +This repository accesses the required WTF handbook's content as a git submodule. Therefore, make sure to check out this repository including its submodule: + +``` +git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git +``` + ### python based - sphinx First create a Python 3 virtual environment using the venv module included with Python 3.