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: Automate Processing of the Documentation.

Browse source 
Automate processing of the documentation to ensure it is processable.
Also fix some bugs in the existing input files for the documentation and
re-enable linting.

Signed-off-by: Michael Keller <github@ike.ch>
This commit is contained in:
Michael Keller 2024-02-10 20:42:01 +13:00 • committed by Dirk Hohndel
parent 4197faf1b7
commit 618e38151a
4 changed files with 16 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Documentation/Makefile
View file

@ -14,7 +14,7 @@ TEXTDOCS = $(patsubst %,$(OUT)%.text,$(DOCNAMES))
PDFDOCS = $(patsubst %,$(OUT)%.pdf,$(DOCNAMES)) PDFDOCS = $(patsubst %,$(OUT)%.pdf,$(DOCNAMES))
ASCIIDOC = asciidoc ASCIIDOC = asciidoc
A2X = a2x -L A2X = a2x
BROWSER = firefox BROWSER = firefox
THEME = compact_subsurface THEME = compact_subsurface
PWD = $(realpath .) PWD = $(realpath .)

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.1.2" /> <meta name="generator" content="AsciiDoc 10.2.0" />
<title></title> <title></title>
<style type="text/css"> <style type="text/css">
/* /*
@ -807,11 +807,9 @@ cellspacing="0" cellpadding="4">
<col width="50%" /> <col width="50%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="imageblock" style="text-align:center;"> <td align="left" valign="top"><div><div class="paragraph"><p><span class="image">
<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" />
</div> </span></p></div></div></td>
</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.
@ -986,11 +984,9 @@ cellspacing="0" cellpadding="4">
<col width="60%" /> <col width="60%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="imageblock" style="float:left;"> <td align="left" valign="top"><div><div class="paragraph"><p><span class="image">
<div class="content">
<img src="mobile-images/StatsPanel.jpg" alt="Image: Statistics panel" /> <img src="mobile-images/StatsPanel.jpg" alt="Image: Statistics panel" />
</div> </span></p></div></div></td>
</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
@ -1173,11 +1169,9 @@ cellspacing="0" cellpadding="4">
<col width="60%" /> <col width="60%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="imageblock" style="text-align:center;"> <td align="left" valign="top"><div><div class="paragraph"><p><span class="image">
<div class="content">
<img src="mobile-images/StatsRegression.jpg" alt="Regression data example" /> <img src="mobile-images/StatsRegression.jpg" alt="Regression data example" />
</div> </span></p></div></div></td>
</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>
@ -1288,11 +1282,9 @@ cellspacing="0" cellpadding="4">
<col width="50%" /> <col width="50%" />
<tbody> <tbody>
<tr> <tr>
<td align="left" valign="top"><div><div class="imageblock" style="text-align:center;"> <td align="left" valign="top"><div><div class="paragraph"><p><span class="image">
<div class="content">
<img src="mobile-images/ThemeSettings.jpg" alt="FIGURE: Theme Settings" /> <img src="mobile-images/ThemeSettings.jpg" alt="FIGURE: Theme Settings" />
</div> </span></p></div></div></td>
</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
@ -1378,7 +1370,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-08 09:34:56 PST 2024-02-10 20:35:39 NZDT
</div> </div>
</div> </div>
</body> </body>

8
Documentation/mobile-manual-v3.txt
View file

@ -339,7 +339,7 @@ This feature is not supported on iOS.
[width="100%"] [width="100%"]
|======= |=======
a|image::mobile-images/USB-OTG.jpg["FIGURE: USB-OTG cable",align="center"] | a|image:mobile-images/USB-OTG.jpg["FIGURE: USB-OTG cable",align="center"] |
Most current Android devices now have a USB 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.
@ -492,7 +492,7 @@ and the dives during the last six months.
[width="100%", cols="2,3"] [width="100%", cols="2,3"]
|=== |===
a|image::mobile-images/StatsPanel.jpg["Image: Statistics panel",float="left"] | a|image:mobile-images/StatsPanel.jpg["Image: Statistics panel",float="left"] |
Creating meaningful statistics that convey the information you are looking for is surprisingly hard. 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
@ -659,7 +659,7 @@ image::mobile-images/StatsBarchartSubdivided.jpg["Stats subdivided barchart",ali
[width="100%", cols="2,3"] [width="100%", cols="2,3"]
|======= |=======
a|image::mobile-images/StatsRegression.jpg["Regression data example",align="center"] | a|image:mobile-images/StatsRegression.jpg["Regression data example",align="center"] |
Sometimes you might wish to investigate the relationship between two dive variables. Has my SAC rate decreased over 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). is to draw a scattergraph where the values of one variable is plotted against the other variable (see image on the left).
@ -758,7 +758,7 @@ buttons on the _Download from dive computer_ page.
[width="100%"] [width="100%"]
|======= |=======
a|image::mobile-images/ThemeSettings.jpg["FIGURE: Theme Settings",align="center"] | a|image:mobile-images/ThemeSettings.jpg["FIGURE: Theme Settings",align="center"] |
Besides the default blue color scheme, _Subsurface-mobile_ supports two additional color schemes Besides the default blue color scheme, _Subsurface-mobile_ 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 _pink_ or _dark_ color theme from based on the blue default color scheme. You can pick the _pink_ or _dark_ color theme from

2
Documentation/user-manual_fr.txt
View file

@ -5291,7 +5291,7 @@ see thumbnails that represent individual videos, _Subsurface_ uses an
external program calle _FFmpeg_. To create thumbnails for videos, do two external program calle _FFmpeg_. To create thumbnails for videos, do two
things: things:
Install _FFmpeg_ on the computer that runs _Subsurface_. The program can be 1. Install _FFmpeg_ on the computer that runs _Subsurface_. The program can be
downloaded from the FFmpeg web site: downloaded from the FFmpeg web site:
https://www.ffmpeg.org/download.html. Most Linux distributions ship with an https://www.ffmpeg.org/download.html. Most Linux distributions ship with an
_ffmpeg_ package and therefore do not need an additional download. _ffmpeg_ package and therefore do not need an additional download.