forked from gulliver/rtfm
Compare commits
18 Commits
b580c8d439
...
212473fe0a
Author | SHA1 | Date | |
---|---|---|---|
|
212473fe0a | ||
|
55577246e7 | ||
|
12b7f299f9 | ||
|
203afb1c4c | ||
|
5ac657ff0e | ||
|
a48bf444e7 | ||
|
1e8da5593a | ||
|
21ddfdbef3 | ||
|
c63c7a7288 | ||
|
63c08521ac | ||
d9ce62fbf9 | |||
9d888fa501 | |||
c47e3f4612 | |||
204abce3b4 | |||
bef5199114 | |||
fdd6b6adee | |||
3aec12d210 | |||
af1449c5f4 |
67
.drone.yml
Normal file
67
.drone.yml
Normal 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
|
||||
|
||||
|
40
README.md
40
README.md
@ -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.
|
||||
|
@ -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 ---------------------------------------------------
|
||||
|
||||
|
Reference in New Issue
Block a user