forked from gulliver/rtfm
Compare commits
9 Commits
v0.2.0
...
898876984b
Author | SHA1 | Date | |
---|---|---|---|
898876984b | |||
c19cacccf3 | |||
6e778c48d6 | |||
87afa4541e | |||
5d62b0f9f0 | |||
e10bb49f68 | |||
17e9225ac4 | |||
2da8a18e36 | |||
0bde0ae0e3 |
10
Makefile
10
Makefile
@ -26,16 +26,6 @@ clean:
|
|||||||
|
|
||||||
sphinx:
|
sphinx:
|
||||||
$(MAKE) singlehtml epub latexpdf
|
$(MAKE) singlehtml epub latexpdf
|
||||||
rm build/singlehtml/_static/base-stemmer.js
|
|
||||||
rm build/singlehtml/_static/basic.css
|
|
||||||
rm build/singlehtml/_static/css/badge_only.css
|
|
||||||
rm build/singlehtml/_static/epub_cover.png
|
|
||||||
rm build/singlehtml/_static/german-stemmer.js
|
|
||||||
rm build/singlehtml/_static/jquery-3.5.1.js
|
|
||||||
rm build/singlehtml/_static/language_data.js
|
|
||||||
rm build/singlehtml/_static/searchtools.js
|
|
||||||
rm build/singlehtml/_static/underscore-1.13.1.js
|
|
||||||
rm build/singlehtml/_static/wtf_coop_header.png
|
|
||||||
|
|
||||||
bundle: sphinx
|
bundle: sphinx
|
||||||
-mkdir bundle
|
-mkdir bundle
|
||||||
|
42
README.md
42
README.md
@ -1,44 +1,34 @@
|
|||||||
[](https://drone.wtf-eg.de/wtf-eg/handbuch-gen)
|
|
||||||
|
|
||||||
# About
|
# About
|
||||||
|
|
||||||
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 repo contains the sphinx configuration and the wtf theme for sphinx for the generation of the WTF handbook.
|
||||||
|
|
||||||
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).
|
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.
|
||||||
|
|
||||||
|
# sphinx html theme for wtf coop
|
||||||
|
|
||||||
|
the sphinx build uses an adapted sphinx theme for the wtf cooperatives CI.
|
||||||
|
|
||||||
# How to build
|
# How to build
|
||||||
|
|
||||||
### Checkout with submodules
|
### python based - sphinx
|
||||||
|
|
||||||
This repository accesses the required WTF handbook's content as a git submodule. Therefore, make sure to check out this repository including its submodule:
|
First create a Python 3 virtual environment using the venv module included with Python 3.
|
||||||
|
|
||||||
```
|
|
||||||
git clone --recurse-submodules https://git.wtf-eg.de/wtf-eg/handbuch-gen.git
|
|
||||||
```
|
|
||||||
|
|
||||||
### Python based dependencies
|
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```
|
||||||
|
|
||||||
In order to generate the documentation, first create a Python 3 virtual environment using the `venv` module included in Python 3:
|
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.
|
||||||
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
|
### 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
|
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'
|
author = 'Autorenkollektiv'
|
||||||
|
|
||||||
# The full version, including alpha/beta/rc tags
|
# The full version, including alpha/beta/rc tags
|
||||||
release = '0.2.0'
|
release = '0.0.5'
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
# -- General configuration ---------------------------------------------------
|
||||||
|
|
||||||
|
Submodule source/handbuch updated: c4ba3f2e8c...8fecdc5822
@ -1,4 +1,4 @@
|
|||||||
.. wtf handdbook documentation master file, created by
|
.. KoLe documentation master file, created by
|
||||||
sphinx-quickstart on Thu Apr 29 23:32:19 2021.
|
sphinx-quickstart on Thu Apr 29 23:32:19 2021.
|
||||||
You can adapt this file completely to your liking, but it should at least
|
You can adapt this file completely to your liking, but it should at least
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
@ -10,7 +10,6 @@ RTFM - Das Handbuch zur wtf Kooperative eG
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Contents:
|
:caption: Contents:
|
||||||
|
|
||||||
handbuch/impressum.md
|
|
||||||
handbuch/intro.md
|
handbuch/intro.md
|
||||||
handbuch/organisation.md
|
handbuch/organisation.md
|
||||||
handbuch/Aufnahmeprozess.md
|
handbuch/Aufnahmeprozess.md
|
||||||
@ -21,3 +20,8 @@ RTFM - Das Handbuch zur wtf Kooperative eG
|
|||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
||||||
|
@ -4,14 +4,16 @@
|
|||||||
*/
|
*/
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: FontAwesome;
|
font-family: FontAwesome;
|
||||||
src: url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2");
|
src: url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),
|
||||||
|
url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff");
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-style: normal
|
font-style: normal
|
||||||
}
|
}
|
||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2");
|
src: url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),
|
||||||
|
url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -19,7 +21,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2");
|
src: url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),
|
||||||
|
url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -27,7 +30,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2");
|
src: url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),
|
||||||
|
url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -35,7 +39,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: Lato;
|
font-family: Lato;
|
||||||
src: url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2");
|
src: url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),
|
||||||
|
url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
font-display: block
|
font-display: block
|
||||||
@ -44,7 +49,8 @@
|
|||||||
/* noto-serif-700 - latin */
|
/* noto-serif-700 - latin */
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Noto Serif Bold';
|
font-family: 'Noto Serif Bold';
|
||||||
src: url('fonts/noto-serif-v9-latin-700.woff2') format('woff2'); /* Modern Browsers */
|
src: url('fonts/noto-serif-v9-latin-700.woff2') format('woff2'), /* Super Modern Browsers */
|
||||||
|
url('fonts/noto-serif-v9-latin-700.woff') format('woff'); /* Modern Browsers */
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
}
|
}
|
||||||
|
Binary file not shown.
Binary file not shown.
BIN
theme/custom_sphinx_rtd_theme/static/css/fonts/lato-bold.woff
Normal file
BIN
theme/custom_sphinx_rtd_theme/static/css/fonts/lato-bold.woff
Normal file
Binary file not shown.
Binary file not shown.
BIN
theme/custom_sphinx_rtd_theme/static/css/fonts/lato-normal.woff
Normal file
BIN
theme/custom_sphinx_rtd_theme/static/css/fonts/lato-normal.woff
Normal file
Binary file not shown.
Binary file not shown.
Reference in New Issue
Block a user