git.gag.com Git - fw/altos/blob - doc/Makefile.am

   1 #
   2 # Copyright © 2018 Keith Packard <keithp@keithp.com>
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation, either version 2 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful, but
  10 # WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # General Public License for more details.
  13 #
  14
  15 if FAKETIME
  16 FAKETIME=TZ=UTC faketime -f '$(RELEASE_DATE) 00:00:00 i0'
  17 endif
  18
  19 RELNOTES_INC=\
  20         release-notes-1.9.1.inc \
  21         release-notes-1.9.inc \
  22         release-notes-1.8.7.inc \
  23         release-notes-1.8.6.inc \
  24         release-notes-1.8.5.inc \
  25         release-notes-1.8.4.inc \
  26         release-notes-1.8.3.inc \
  27         release-notes-1.8.2.inc \
  28         release-notes-1.8.1.inc \
  29         release-notes-1.8.inc \
  30         release-notes-1.7.inc \
  31         release-notes-1.6.8.inc \
  32         release-notes-1.6.5.inc \
  33         release-notes-1.6.4.inc \
  34         release-notes-1.6.3.inc \
  35         release-notes-1.6.2.inc \
  36         release-notes-1.6.1.inc \
  37         release-notes-1.6.inc \
  38         release-notes-1.5.inc \
  39         release-notes-1.4.2.inc \
  40         release-notes-1.4.1.inc \
  41         release-notes-1.4.inc \
  42         release-notes-1.3.2.inc \
  43         release-notes-1.3.1.inc \
  44         release-notes-1.3.inc \
  45         release-notes-1.2.1.inc \
  46         release-notes-1.2.inc \
  47         release-notes-1.1.1.inc \
  48         release-notes-1.1.inc \
  49         release-notes-1.0.1.inc \
  50         release-notes-0.9.2.inc \
  51         release-notes-0.9.inc \
  52         release-notes-0.8.inc \
  53         release-notes-0.7.1.inc
  54
  55 IMAGES=\
  56         altosui.png \
  57         ascent.png \
  58         configure-altimeter.png \
  59         configure-altosui.png \
  60         configure-groundstation.png \
  61         configure-pyro.png \
  62         descent.png \
  63         device-selection.png \
  64         easymega.svg \
  65         easymega-v1.0-bottom.jpg \
  66         easymega-v1.0-top.jpg \
  67         easymini.svg \
  68         easymini-top.jpg \
  69         fire-igniter.png \
  70         graph-configure.png \
  71         graph-map.png \
  72         graph.png \
  73         graph-stats.png \
  74         ignitor.png \
  75         landed.png \
  76         launch-pad.png \
  77         load-maps.png \
  78         micropeak-app.png \
  79         micropeak-back.jpg \
  80         micropeak-device-dialog.png \
  81         micropeak-dime.jpg \
  82         micropeak-download.png \
  83         micropeak-graph-configure.png \
  84         micropeak-graph.png \
  85         micropeak-nofont.svg \
  86         micropeak-preferences.png \
  87         micropeak-raw-data.png \
  88         micropeak-save-dialog.png \
  89         micropeak-statistics.png \
  90         MicroPeakUSB-2.0-inuse.jpg \
  91         MicroPeakUSB-2.0.jpg \
  92         monitor-idle.png \
  93         scan-channels.png \
  94         site-map.png \
  95         table.png \
  96         telegps-configure.png \
  97         telegps-graph-configure.png \
  98         telegps-graph-graph.png \
  99         telegps-graph-map.png \
 100         telegps-graph-stats.png \
 101         telegps-info.png \
 102         telegps-location.png \
 103         telegps-map.png \
 104         telegps-preferences.png \
 105         telegps-scan.png \
 106         telegps-status.png \
 107         telegps-table.png \
 108         telegps-v1.0-top.jpg \
 109         telemega.svg \
 110         telemega-v1.0-top.jpg \
 111         telemetrum.svg \
 112         telemetrum-v1.1-thside.jpg \
 113         telemetrum-v2.0-th.jpg \
 114         telemini-v1.svg \
 115         telemini-v1-top.jpg \
 116         telemini-v3.svg \
 117         telemini-v3.0-top.jpg \
 118         telemini-v3.0-bottom.jpg \
 119         altusmetrum-oneline.svg \
 120         telegps-oneline.svg \
 121         micropeak-oneline.svg
 122
 123 TXT_FILES=altusmetrum.txt
 124
 125 COMMON_INC_FILES=\
 126         config-device.inc \
 127         config-ui.inc \
 128         load-maps.inc \
 129         aprs-operation.inc \
 130         handling.inc \
 131         release-head.inc
 132
 133 INC_FILES=\
 134         header.inc \
 135         dedication.inc \
 136         intro.inc \
 137         getting-started.inc \
 138         usage.inc \
 139         telemetrum.inc \
 140         telemini.inc \
 141         easymini-device.inc \
 142         telemega.inc \
 143         easymega.inc \
 144         installation.inc \
 145         using-am-products.inc \
 146         updating-firmware.inc \
 147         altosui.inc \
 148         altosdroid.inc \
 149         system-operation.inc \
 150         pyro-channels.inc \
 151         flight-data-recording.inc \
 152         specs.inc \
 153         $(COMMON_INC_FILES) \
 154         release-notes.inc \
 155         $(RELNOTES_INC)
 156
 157 ADOC_FILES=$(TXT_FILES:.txt=.adoc) $(INC_FILES:.inc=.adoc)
 158
 159 TELELAUNCH_TXT_FILES=altusmetrum.txt
 160
 161 TELELAUNCH_INC_FILES=\
 162         header.inc \
 163         telelaunch-acknowledgements.inc \
 164         telelaunch-intro.inc \
 165         telelaunch-configuration.inc \
 166         telelaunch-operation.inc \
 167         telelaunch-specs.inc \
 168         telelaunch-updating-firmware.inc \
 169         telelaunch-cables.inc \
 170         telelaunch-troubleshooting.inc
 171
 172 TELELAUNCH_ADOC_FILES=$(TELELAUNCH_TXT_FILES:.txt=.adoc) $(TELELAUNCH_INC_FILES:.inc=.adoc)
 173
 174 TELEGPS_INC_FILES=\
 175         telegps-dedication.inc \
 176         telegps-quick-start.inc \
 177         telegps-using.inc \
 178         telegps-system-operation.inc \
 179         telegps-application.inc \
 180         telegps-specs.inc \
 181         telegps-updating-firmware.inc \
 182         telegps-release-notes.inc \
 183         $(COMMON_INC_FILES)
 184
 185 TELEGPS_TXT_FILES=\
 186         telegps.txt
 187
 188 TELEGPS_ADOC_FILES=$(TELEGPS_TXT_FILES:.txt=.adoc) $(TELEGPS_INC_FILES:.inc=.adoc)
 189
 190 MICROPEAK_TXT_FILES=\
 191         micropeak.txt
 192
 193 MICROPEAK_INC_FILES=
 194
 195 MICROPEAK_ADOC_FILES=$(MICROPEAK_TXT_FILES:.txt=.adoc) $(MICROPEAK_INC_FILES:.inc=.adoc)
 196
 197 EASYMINI_TXT_FILES=\
 198         easymini.txt
 199
 200 EASYMINI_INC_FILES=$(INC_FILES) easymini-release-notes.inc
 201
 202
 203 EASYMINI_ADOC_FILES=$(EASYMINI_TXT_FILES:.txt=.adoc) $(EASYMINI_INC_FILES:.inc=.adoc)
 204
 205 OUTLINE_TXT_FILES=\
 206         easymega-outline.txt \
 207         easymini-outline.txt \
 208         telemega-outline.txt \
 209         telemetrum-outline.txt \
 210         telemini-v1-outline.txt \
 211         telemini-v3-outline.txt \
 212         telegps-outline.txt
 213
 214 OUTLINE_ADOC_FILES=$(OUTLINE_TXT_FILES:.txt=.adoc)
 215
 216 OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf)
 217
 218 SVG=\
 219         easymini.svg \
 220         telemega.svg \
 221         telemetrum.svg \
 222         telemini-v1.svg \
 223         telemini-v3.svg \
 224         easymega.svg
 225
 226 RELNOTES_HTML=$(RELNOTES_INC:.inc=.html)
 227
 228 ONEFILE_TXT_FILES=\
 229         altos.txt \
 230         companion.txt \
 231         telemetry.txt \
 232         map-loading.txt
 233
 234 ONEFILE_ADOC_FILES=$(ONEFILE_TXT_FILES:.txt=.adoc)
 235 ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf)
 236 ONEFILE_HTML_FILES=$(ONEFILE_TXT_FILES:.txt=.html)
 237
 238 AM_HTML=am.html
 239
 240 PUBLISH_HTML=altusmetrum.html micropeak.html telegps.html easymini.html telelaunch.html $(ONEFILE_HTML_FILES)
 241
 242 HTML=$(PUBLISH_HTML) $(RELNOTES_HTML)
 243
 244 if ASCIIDOCTOR_PDF
 245 PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf telelaunch.pdf $(ONEFILE_PDF_FILES) \
 246         $(OUTLINE_PDF_FILES)
 247 endif
 248
 249 MAP_DOT_FILES=map-loading.dot
 250 MAP_SVG_FILES=$(MAP_DOT_FILES:.dot=.svg)
 251 STYLESHEET=am.css am-notoc.css
 252
 253 FONTS=\
 254         fonts/DejaVuSansMono-BoldOblique.ttf \
 255         fonts/DejaVuSansMono-Bold.ttf \
 256         fonts/DejaVuSansMono-Oblique.ttf \
 257         fonts/DejaVuSansMono.ttf \
 258         fonts/OpenSans-Light.ttf \
 259         fonts/OpenSans-LightItalic.ttf \
 260         fonts/OpenSans-Regular.ttf \
 261         fonts/OpenSans-Italic.ttf \
 262         fonts/OpenSans-Semibold.ttf \
 263         fonts/OpenSans-SemiboldItalic.ttf
 264
 265 ICONS=\
 266         images/icons/caution.svg \
 267         images/icons/important.svg \
 268         images/icons/note.svg \
 269         images/icons/tip.svg \
 270         images/icons/warning.svg
 271
 272 PDF_CONFIG_FILES=altusmetrum-theme.yml
 273 HTML_CONFIG_FILES=
 274
 275 PUBLISH_DOC=$(PUBLISH_HTML) $(PDF) $(IMAGES) $(MAP_SVG_FILES) $(STYLESHEET)
 276
 277 DOC=$(HTML) $(PDF) $(IMAGES) $(MAP_SVG_FILES) $(STYLESHEET)
 278
 279 SUFFIXES = .dot .svg .inc .txt .adoc .pdf .html
 280
 281 .dot.svg:
 282         dot -Tsvg -o$@ $*.dot
 283
 284 .txt.adoc:
 285         sed -e 's/^[    ]*//' -e 's/^\\//' $*.txt > $@
 286
 287 .inc.adoc:
 288         sed -e 's/^[    ]*//' -e 's/^\\//' $*.inc > $@
 289
 290 .adoc.html:
 291         asciidoctor -b html5 $*.adoc
 292
 293 .adoc.pdf:
 294         asciidoctor-pdf $*.adoc
 295
 296 all:    $(HTML) $(PDF)
 297
 298 map-loading.adoc: $(MAP_SVG_FILES)
 299
 300 altusmetrum.pdf altusmetrum.html: $(ADOC_FILES) $(IMAGES)
 301
 302 telelaunch.pdf telelaunch.html: $(TELELAUNCH_ADOC_FILES) $(IMAGES)
 303
 304 telegps.html telegps.pdf: $(TELEGPS_ADOC_FILES) $(IMAGES)
 305
 306 micropeak.pdf micropeak.html: $(MICROPEAK_ADOC_FILES) $(IMAGES)
 307
 308 easymini.pdf easymini.html: $(EASYMINI_ADOC_FILES) $(IMAGES)
 309
 310 telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg
 311
 312 telemini-v3-outline.pdf: telemini-v3-outline.txt telemini-v3.svg
 313
 314 install:        all
 315
 316 WEB_ROOT=/home/bdale/web/
 317
 318 publish:        $(PUBLISH_DOC) $(FONTS) $(ICONS)
 319         cp -a $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/
 320         mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/
 321         cp $(FONTS) $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/
 322         mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/
 323         cp $(ICONS) $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/
 324         (cd $(WEB_ROOT)/altusmetrum ; \
 325          git add $(WEB_ROOT)/altusmetrum/AltOS/doc/* ; \
 326          git add $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \
 327          git add $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/* ;\
 328          echo "update docs" | \
 329          git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons ; \
 330          git push)
 331
 332 publish-keithp: am.html $(DOC) $(FONTS)
 333         ssh keithp.com 'mkdir -p ~keithp/public_html/altos/fonts ~keithp/public_html/altos/images/icons'
 334         scp -p am.html $(DOC) keithp.com:~keithp/public_html/altos
 335         scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts
 336         scp -p $(ICONS) keithp.com:~keithp/public_html/altos/images/icons
 337
 338 clean:
 339         rm -f am.html $(HTML) $(PDF) $(ADOC_FILES) $(TELEGPS_ADOC_FILES) $(MICROPEAK_ADOC_FILES) $(TELELAUNCH_ADOC_FILES)
 340
 341 distclean: clean
 342         rm -f $(HTML) $(PDF)
 343
 344 $(PDF): $(PDF_CONFIG_FILES)
 345 $(HTML): $(HTML_CONFIG_FILES)
 346
 347 am.html: Makefile make-am-html $(HTML)
 348         sh ./make-am-html $(HTML) > $@