Skip to content

Commit 49ceb10

Browse files
marc1706marc1706
authored
Merge pull request #284 from phpbb/actions/build_pdf
Create documentation PDF with github actions
2 parents c13fe9c + 1eba9d6 commit 49ceb10

Some content is hidden

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

43 files changed

+47
-86
lines changed

‎.github/workflows/tests.yml

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ on:
1111
- '[34].[0-9]+.x'
1212

1313
jobs:
14-
build:
14+
build-dev-docs:
15+
name: 'Build development docs'
1516
runs-on: ubuntu-latest
1617
steps:
17-
- uses: actions/checkout@v2
18+
- uses: actions/checkout@v4
1819
- name: Set up Python
19-
uses: actions/setup-python@v2
20+
uses: actions/setup-python@v4
2021
with:
2122
python-version: '3.x'
2223
- name: Install dependencies
@@ -31,3 +32,35 @@ jobs:
3132
run: |
3233
cd development
3334
make html
35+
36+
build-user-docs-pdf:
37+
name: 'Build user docs PDF'
38+
runs-on: ubuntu-latest
39+
steps:
40+
- uses: actions/checkout@v4
41+
- name: Install fop
42+
run: |
43+
sudo apt-get install -y fop
44+
- name: Build pdf documentation
45+
working-directory: ${{ github.workspace }}/documentation
46+
run: |
47+
./create_pdf.sh
48+
- name: Archive PDF output
49+
uses: actions/upload-artifact@v4
50+
with:
51+
name: Documentation PDF
52+
path: ${{ github.workspace }}/documentation/*.pdf
53+
54+
build-user-docs-website:
55+
name: 'Build user docs for website'
56+
runs-on: ubuntu-latest
57+
steps:
58+
- uses: actions/checkout@v4
59+
- name: Install xsltproc
60+
run: |
61+
sudo apt-get install -y xsltproc
62+
- name: Build documentation for website
63+
working-directory: ${{ github.workspace }}/documentation
64+
run: |
65+
mkdir build_website
66+
./create_docs.sh build_website

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Thumbs.db
22
.DS_Store
3+
.idea/
34
/development/_build
45
/documentation/build

‎documentation/content/cs/chapters/admin_guide.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
32
<chapter id="admin_guide">
43
<?dbhtml dir="adminguide" filename="index.html" ?>
54
<chapterinfo>

‎documentation/content/cs/chapters/glossary.xml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.docbook.org/xml/4.4/docbookx.dtd">
32
<chapter id="glossary">
43
<?dbhtml dir="glossary" filename="index.html" ?>
54
<chapterinfo>

‎documentation/content/cs/chapters/moderator_guide.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3-
"http://www.docbook.org/xml/4.4/docbookx.dtd">
42
<chapter id="moderator_guide">
53
<?dbhtml dir="moderatorguide" filename="index.html" ?>
64
<chapterinfo>

‎documentation/content/cs/chapters/quick_start_guide.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3-
"http://www.docbook.org/xml/4.4/docbookx.dtd">
42
<chapter id="quick_start_guide">
53
<?dbhtml dir="quickstart" filename="index.html" ?>
64
<chapterinfo>

‎documentation/content/cs/chapters/upgrade_guide.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3-
"http://www.docbook.org/xml/4.4/docbookx.dtd">
42
<chapter id="upgrade_guide">
53
<?dbhtml dir="upgradeguide" filename="index.html" ?>
64
<chapterinfo>

‎documentation/content/cs/chapters/user_guide.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3-
"http://www.docbook.org/xml/4.4/docbookx.dtd">
42
<chapter id="user_guide">
53
<?dbhtml dir="userguide" filename="index.html" ?>
64
<chapterinfo>

‎documentation/content/da/chapters/admin_guide.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3-
"http://www.docbook.org/xml/4.4/docbookx.dtd">
42
<chapter id="admin_guide">
53
<?dbhtml dir="adminguide" filename="index.html" ?>
64
<chapterinfo>

‎documentation/content/da/chapters/glossary.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3-
"http://www.docbook.org/xml/4.4/docbookx.dtd">
42
<chapter id="glossary">
53
<?dbhtml dir="glossary" filename="index.html" ?>
64
<chapterinfo>

0 commit comments

Comments
 (0)