Skip to content

Commit 4834bae

Browse files
committed
Merged documentation branch.
Squashed commit of the following: commit b870fdcbba1bd886e15ca13624b5bf9862edbc44 Author: Andreas Dewes <[email protected]> Date: Thu May 20 16:19:59 2021 +0200 Only build master branch. commit ba53524 Author: Andreas Dewes <[email protected]> Date: Thu May 20 16:19:37 2021 +0200 Fixed translation notice text. commit c1bd99f Author: Andreas Dewes <[email protected]> Date: Thu May 20 16:15:58 2021 +0200 Minor fixes. commit c774e53 Author: Andreas Dewes <[email protected]> Date: Thu May 20 16:11:46 2021 +0200 Fix translation notice. commit f13c025 Author: Andreas Dewes <[email protected]> Date: Thu May 20 16:08:52 2021 +0200 Fix paths. commit b62229c Author: Andreas Dewes <[email protected]> Date: Thu May 20 16:02:26 2021 +0200 Fixed paths to make them compatible with Github pages. commit bc6b339 Author: Andreas Dewes <[email protected]> Date: Thu May 20 15:48:31 2021 +0200 Also use 'cd' in main step (as it doesn't remember directories) commit d761cac Author: Andreas Dewes <[email protected]> Date: Thu May 20 15:41:50 2021 +0200 Change into the correct directory. commit c3c279d Author: Andreas Dewes <[email protected]> Date: Thu May 20 15:38:55 2021 +0200 Wrap 'echo' call. commit c43c3e4 Author: Andreas Dewes <[email protected]> Date: Thu May 20 15:35:03 2021 +0200 Use sudo. commit 96cd8fe Author: Andreas Dewes <[email protected]> Date: Thu May 20 15:31:41 2021 +0200 Added workflow to build and deploy documentation (still testing) commit 3e808a3 Author: Andreas Dewes <[email protected]> Date: Thu May 20 14:19:39 2021 +0200 Initial version of proper documentation.
1 parent ddb8d77 commit 4834bae

File tree

210 files changed

+18348
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+18348
-0
lines changed

.github/workflows/build-docs.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Build the documentation website
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
build:
10+
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: Set up docs
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: 3.8
19+
- name: Install dependencies
20+
run: |
21+
sudo apt-get update -qy
22+
sudo apt-get install -y curl tidy optipng python3 python3-pip locales rsync nodejs npm openssh-client expect
23+
sudo pip3 install virtualenv
24+
sudo npm install -g n
25+
sudo n 15
26+
sudo sh -c 'echo "en_US UTF-8" > /etc/locale.gen'
27+
sudo locale-gen en_US.UTF-8
28+
export LANG=en_US.UTF-8
29+
export LANGUAGE=en_US:en
30+
export LC_ALL=en_US.UTF-8
31+
cd docs
32+
make setup
33+
- name: Build docs
34+
run: |
35+
cd docs
36+
make SITE=src/site-prod.yml
37+
make optimize-html
38+
- name: Deploy docs
39+
uses: JamesIves/[email protected]
40+
with:
41+
branch: gh-pages
42+
folder: docs/build

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
*.pprof
22
.*
3+
!.github
34
!.scripts

docs/.babelrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"presets" : ["es2015", "react", "stage-2", "minify"]
3+
}

docs/.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
node_modules
2+
.*
3+
main.css
4+
*.pid
5+
*tmp/*
6+
.checkmate/*
7+
*~
8+
output/*
9+
bower_components
10+
build*
11+
**/settings/common.py
12+
*.orig
13+
*#
14+
**/venv/*
15+
*.pyc
16+
*.db
17+
*.dat
18+
upload/*

0 commit comments

Comments
 (0)