mifr/subsurface
1
0
Fork 0
mirror of https://github.com/subsurface/subsurface.git synced 2025-02-19 22:16:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

CICD: Add GitHub Action File for Documentation Processing.

Browse source 
Also add an appropriate branch condition to the actions building
docker images.

Signed-off-by: Michael Keller <github@ike.ch>
This commit is contained in:
Michael Keller 2024-02-10 20:57:19 +13:00 • committed by Dirk Hohndel
parent 618e38151a
commit 8181048611
4 changed files with 55 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/android-dockerimage.yml vendored
View file

@ -2,6 +2,8 @@ name: Android Docker Image CI
on: on:
push: push:
branches:
- master
paths: paths:
- scripts/docker/android-build-container/** - scripts/docker/android-build-container/**
- .github/workflows/android-dockerimage.yml - .github/workflows/android-dockerimage.yml

33
.github/workflows/documentation.yml vendored Normal file
View file

@ -0,0 +1,33 @@
name: Documentation
on:
push:
branches:
- master
paths:
- Documentation
- .github/workflows/documentation.yml
pull_request:
branches:
- master
paths:
- Documentation
- .github/workflows/documentation.yml
jobs:
documentation:
runs-on: ubuntu-22.04
steps:
- name: Install Packages
run: |
sudo apt-get -y update
sudo apt-get -y install asciidoc docbook-xml w3m
- name: Checkout Sources
uses: actions/checkout@v4
- name: Process the Documentation
id: process_documentation
working-directory: Documentation
run: make

2
.github/workflows/windows-mxe-dockerimage.yml vendored
View file

@ -2,6 +2,8 @@ name: Windows (MXE) Docker Image
on: on:
push: push:
branches:
- master
paths: paths:
- scripts/docker/mxe-build-container/** - scripts/docker/mxe-build-container/**
- .github/workflows/windows-mxe-dockerimage.yml - .github/workflows/windows-mxe-dockerimage.yml

28
Documentation/mobile-manual-v3.html.git
View file

@ -4,7 +4,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head> <head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" /> <meta name="generator" content="AsciiDoc 10.1.2" />
<title></title> <title></title>
<style type="text/css"> <style type="text/css">
/* /*
@ -807,9 +807,11 @@ cellspacing="0" cellpadding="4">
<col width="50%" /> <col width="50%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="paragraph"><p><span class="image"> <td align="left" valign="top"><div><div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/USB-OTG.jpg" alt="FIGURE: USB-OTG cable" /> <img src="mobile-images/USB-OTG.jpg" alt="FIGURE: USB-OTG cable" />
</span></p></div></div></td> </div>
</div></div></td>
<td align="left" valign="top"><p class="table">Most current Android devices now have a USB <td align="left" valign="top"><p class="table">Most current Android devices now have a USB
Type C port and come with a simple A-to-C adapter plug, which lets you plug in Type C port and come with a simple A-to-C adapter plug, which lets you plug in
the dive computer cable into the phone or tablet. the dive computer cable into the phone or tablet.
@ -984,9 +986,11 @@ cellspacing="0" cellpadding="4">
<col width="60%" /> <col width="60%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="paragraph"><p><span class="image"> <td align="left" valign="top"><div><div class="imageblock" style="float:left;">
<div class="content">
<img src="mobile-images/StatsPanel.jpg" alt="Image: Statistics panel" /> <img src="mobile-images/StatsPanel.jpg" alt="Image: Statistics panel" />
</span></p></div></div></td> </div>
</div></div></td>
<td align="left" valign="top"><p class="table">Creating meaningful statistics that convey the information you are looking for is surprisingly hard. <td align="left" valign="top"><p class="table">Creating meaningful statistics that convey the information you are looking for is surprisingly hard.
Different users have very different needs and very different expectations. Subsurface-Mobile provides Different users have very different needs and very different expectations. Subsurface-Mobile provides
a rather detailed set of statistics features to summarize information from the dive log in a graphical a rather detailed set of statistics features to summarize information from the dive log in a graphical
@ -1169,9 +1173,11 @@ cellspacing="0" cellpadding="4">
<col width="60%" /> <col width="60%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="paragraph"><p><span class="image"> <td align="left" valign="top"><div><div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/StatsRegression.jpg" alt="Regression data example" /> <img src="mobile-images/StatsRegression.jpg" alt="Regression data example" />
</span></p></div></div></td> </div>
</div></div></td>
<td align="left" valign="top"><p class="table">Sometimes you might wish to investigate the relationship between two dive variables. Has my SAC rate decreased over <td align="left" valign="top"><p class="table">Sometimes you might wish to investigate the relationship between two dive variables. Has my SAC rate decreased over
the years? Is the water temperature colder at greater dive depth? One of the ways of investigating these questions the years? Is the water temperature colder at greater dive depth? One of the ways of investigating these questions
is to draw a scattergraph where the values of one variable is plotted against the other variable (see image on the left).</p></td> is to draw a scattergraph where the values of one variable is plotted against the other variable (see image on the left).</p></td>
@ -1282,9 +1288,11 @@ cellspacing="0" cellpadding="4">
<col width="50%" /> <col width="50%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="paragraph"><p><span class="image"> <td align="left" valign="top"><div><div class="imageblock" style="text-align:center;">
<div class="content">
<img src="mobile-images/ThemeSettings.jpg" alt="FIGURE: Theme Settings" /> <img src="mobile-images/ThemeSettings.jpg" alt="FIGURE: Theme Settings" />
</span></p></div></div></td> </div>
</div></div></td>
<td align="left" valign="top"><p class="table">Besides the default blue color scheme, <em>Subsurface-mobile</em> supports two additional color schemes <td align="left" valign="top"><p class="table">Besides the default blue color scheme, <em>Subsurface-mobile</em> supports two additional color schemes
for users with different tastes (see image on left). All screenshots shown in this user manual are for users with different tastes (see image on left). All screenshots shown in this user manual are
based on the blue default color scheme. You can pick the <em>pink</em> or <em>dark</em> color theme from based on the blue default color scheme. You can pick the <em>pink</em> or <em>dark</em> color theme from
@ -1370,7 +1378,7 @@ you to reset the password for your <em>Subsurface Cloud</em> account.</p></div>
<div id="footer"> <div id="footer">
<div id="footer-text"> <div id="footer-text">
Last updated Last updated
2024-02-10 20:35:39 NZDT 2024-02-08 09:34:56 PST
</div> </div>
</div> </div>
</body> </body>