Compare commits

...

18 Commits

Author SHA1 Message Date
Gulliver
212473fe0a +apt update
Some checks failed
continuous-integration/drone/pr Build is failing
2021-12-04 18:01:45 +01:00
Gulliver
55577246e7 git sinstall 2021-12-04 18:01:45 +01:00
Gulliver
12b7f299f9 separate step for submodules 2021-12-04 18:01:45 +01:00
Gulliver
203afb1c4c added recursive git cloning 2021-12-04 18:01:45 +01:00
Gulliver
5ac657ff0e cd .. removed 2021-12-04 18:01:45 +01:00
Gulliver
a48bf444e7 added export for noninteractive backend on apt upgrade 2021-12-04 18:01:45 +01:00
Gulliver
1e8da5593a updated installed packages and pip packages 2021-12-04 18:01:45 +01:00
Gulliver
21ddfdbef3 copied drone yaml 2021-12-04 18:01:45 +01:00
Gulliver
c63c7a7288 handbuch module and version information updated to v0.2.0 2021-12-04 17:58:16 +01:00
Gulliver
63c08521ac updated handbuch module 2021-12-04 17:50:45 +01:00
d9ce62fbf9 Final corrections in README 2021-11-17 22:57:32 +01:00
9d888fa501 Fix link 2021-11-17 22:57:32 +01:00
c47e3f4612 Fixing the Markdown link syntax (ouch) 2021-11-17 22:57:32 +01:00
204abce3b4 Changed heading levels back to original, added some more info and cross references 2021-11-17 22:57:32 +01:00
bef5199114 Update README 2021-11-17 22:57:32 +01:00
fdd6b6adee Change README section with dependencies 2021-11-17 22:57:32 +01:00
3aec12d210 Add tiny comments to explain Python's venv module 2021-11-17 22:57:32 +01:00
af1449c5f4 Add info how to checkout this repo properly 2021-11-17 22:57:32 +01:00
3 changed files with 92 additions and 17 deletions

67
.drone.yml Normal file
View File

@ -0,0 +1,67 @@
kind: pipeline
type: docker
name: amd64-pull
platform:
os: linux
arch: amd64
steps:
- name: submodules
image: ubuntu:focal
commands:
- apt-get -y update
- apt-get -y install git
- git submodule update --init --recursive
- name: build-and-test
image: ubuntu:focal
commands:
- export DEBIAN_FRONTEND=noninteractive
- apt-get -y update
- apt-get -y install graphviz plantuml make python3-pip git
- pip install -r requirements.txt
- make bundle
trigger:
branch:
- main
event:
- pull_request
---
kind: pipeline
type: docker
name: amd64-master
platform:
os: linux
arch: amd64
steps:
- name: submodules
image: ubuntu:focal
commands:
- apt-get -y update
- apt-get -y install git
- git submodule update --init --recursive
- name: build-and-test
image: ubuntu:focal
commands:
- export DEBIAN_FRONTEND=noninteractive
- export DRONE_BUILD_DIR=$PWD
- apt-get -y update
- apt-get -y install graphviz plantuml make python3 python3-pip git
- pip install -r requirements.txt
- make -j4 bundle
trigger:
branch:
- master
event:
- push

View File

@ -2,35 +2,43 @@
# About
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 the WTF handbook in various output formats (HTML, epub and pdf) from the [git repository for the WTF handbook](https://git.wtf-eg.de/wtf-eg/handbuch). The handbuch sources are included as git submodule.
this project is an experiment of how to generate html, epub and pdf
from the git repository for the WTF Handbook.
The handbuch sources are included as git submodule.
This repository contains the [Sphinx](https://www.sphinx-doc.org/) configuration and a Sphinx theme adapted for the [corporate identity of WTF cooperation](https://git.wtf-eg.de/ag_kommunikation/wtf_propaganda).
# sphinx html theme for wtf coop
the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI.
# How to build
### python based - sphinx
### Checkout with submodules
First create a Python 3 virtual environment using the venv module included with Python 3.
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
```
1. Create a virtual Python environment: ```python3 -m venv venv```
2. Activate virtual Python environment: ```source venv/bin/activate```
3. install needed packages from ```requirements.txt```: ```pip install -r requirements.txt```
### Python based dependencies
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.
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
1. Create a virtual Python environment in the directory `venv`: ```python3 -m venv venv```
1. Activate the virtual Python environment: ```source venv/bin/activate```
1. Install the packages listed in [requirements.txt](./requirements.txt) using `pip`: ```pip install -r requirements.txt```
### Other dependencies
For generating the images from PlantUML sources (`*.plantuml`), [PlantUML](https://plantuml.com/) is required.
For pdf output the LaTeX builder is used, so `latex` and `pdflatex` need to be installed.
### Running the document generation via make
The top level directory contains a Makefile,
for generation with all output formats use
The top level directory contains a Makefile, for generation with all output formats use
`````
make bundle
`````
The output files of the final handbook can be found in the subfolder `./bundle`.
All generated intermediate artifacts and the final output files can be found in the `./build` subfolder.

View File

@ -24,7 +24,7 @@ copyright = '2021, diverse'
author = 'Autorenkollektiv'
# The full version, including alpha/beta/rc tags
release = '0.1.0'
release = '0.2.0'
# -- General configuration ---------------------------------------------------