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.17.inc \
  21         release-notes-1.9.16.inc \
  22         release-notes-1.9.15.inc \
  23         release-notes-1.9.14.inc \
  24         release-notes-1.9.13.inc \
  25         release-notes-1.9.12.inc \
  26         release-notes-1.9.11.inc \
  27         release-notes-1.9.10.inc \
  28         release-notes-1.9.9.inc \
  29         release-notes-1.9.8.inc \
  30         release-notes-1.9.7.inc \
  31         release-notes-1.9.6.inc \
  32         release-notes-1.9.5.inc \
  33         release-notes-1.9.4.inc \
  34         release-notes-1.9.3.inc \
  35         release-notes-1.9.2.inc \
  36         release-notes-1.9.1.inc \
  37         release-notes-1.9.inc \
  38         release-notes-1.8.7.inc \
  39         release-notes-1.8.6.inc \
  40         release-notes-1.8.5.inc \
  41         release-notes-1.8.4.inc \
  42         release-notes-1.8.3.inc \
  43         release-notes-1.8.2.inc \
  44         release-notes-1.8.1.inc \
  45         release-notes-1.8.inc \
  46         release-notes-1.7.inc \
  47         release-notes-1.6.8.inc \
  48         release-notes-1.6.5.inc \
  49         release-notes-1.6.4.inc \
  50         release-notes-1.6.3.inc \
  51         release-notes-1.6.2.inc \
  52         release-notes-1.6.1.inc \
  53         release-notes-1.6.inc \
  54         release-notes-1.5.inc \
  55         release-notes-1.4.2.inc \
  56         release-notes-1.4.1.inc \
  57         release-notes-1.4.inc \
  58         release-notes-1.3.2.inc \
  59         release-notes-1.3.1.inc \
  60         release-notes-1.3.inc \
  61         release-notes-1.2.1.inc \
  62         release-notes-1.2.inc \
  63         release-notes-1.1.1.inc \
  64         release-notes-1.1.inc \
  65         release-notes-1.0.1.inc \
  66         release-notes-0.9.2.inc \
  67         release-notes-0.9.inc \
  68         release-notes-0.8.inc \
  69         release-notes-0.7.1.inc
  70
  71 IMAGES=\
  72         altosui.png \
  73         ascent.png \
  74         configure-altimeter.png \
  75         configure-altosui.png \
  76         configure-groundstation.png \
  77         configure-pyro.png \
  78         descent.png \
  79         device-selection.png \
  80         easymega.svg \
  81         easymega-v1.0-bottom.jpg \
  82         easymega-v1.0-top.jpg \
  83         easymini.svg \
  84         easymini-top.jpg \
  85         easytimer.jpg \
  86         fire-igniter.png \
  87         graph-configure.png \
  88         graph-map.png \
  89         graph.png \
  90         graph-stats.png \
  91         ignitor.png \
  92         landed.png \
  93         launch-pad.png \
  94         load-maps.png \
  95         micropeak-app.png \
  96         micropeak-back.jpg \
  97         micropeak-device-dialog.png \
  98         micropeak-dime.jpg \
  99         micropeak-download.png \
 100         micropeak-graph-configure.png \
 101         micropeak-graph.png \
 102         micropeak-nofont.svg \
 103         micropeak-preferences.png \
 104         micropeak-raw-data.png \
 105         micropeak-save-dialog.png \
 106         micropeak-statistics.png \
 107         MicroPeakUSB-2.0-inuse.jpg \
 108         MicroPeakUSB-2.0.jpg \
 109         monitor-idle.png \
 110         scan-channels.png \
 111         site-map.png \
 112         table.png \
 113         telegps-configure.png \
 114         telegps-graph-configure.png \
 115         telegps-graph-graph.png \
 116         telegps-graph-map.png \
 117         telegps-graph-stats.png \
 118         telegps-info.png \
 119         telegps-location.png \
 120         telegps-map.png \
 121         telegps-preferences.png \
 122         telegps-scan.png \
 123         telegps-status.png \
 124         telegps-table.png \
 125         telegps-v1.0-top.jpg \
 126         telemega.svg \
 127         telemega-v1.0-top.jpg \
 128         telemetrum.svg \
 129         telemetrum-v1.1-thside.jpg \
 130         telemetrum-v2.0-th.jpg \
 131         telemini-v1.svg \
 132         telemini-v1-top.jpg \
 133         telemini-v3.svg \
 134         telemini-v3.0-top.jpg \
 135         telemini-v3.0-bottom.jpg \
 136         altusmetrum-oneline.svg \
 137         telegps-oneline.svg \
 138         micropeak-oneline.svg
 139
 140 TXT_FILES=altusmetrum.txt
 141
 142 COMMON_INC_FILES=\
 143         config-device.inc \
 144         config-ui.inc \
 145         load-maps.inc \
 146         aprs-operation.inc \
 147         pyro-examples.inc \
 148         handling.inc \
 149         release-head.inc
 150
 151 INC_FILES=\
 152         header.inc \
 153         dedication.inc \
 154         intro.inc \
 155         getting-started.inc \
 156         usage.inc \
 157         telemetrum.inc \
 158         telemini.inc \
 159         easymini-device.inc \
 160         telemega.inc \
 161         easymega.inc \
 162         easytimer.inc \
 163         installation.inc \
 164         using-am-products.inc \
 165         updating-firmware.inc \
 166         frequency-cal.inc \
 167         altosui.inc \
 168         altosdroid.inc \
 169         system-operation.inc \
 170         pyro-channels.inc \
 171         flight-data-recording.inc \
 172         specs.inc \
 173         $(COMMON_INC_FILES) \
 174         release-notes.inc \
 175         $(RELNOTES_INC)
 176
 177 ADOC_FILES=$(TXT_FILES:.txt=.adoc) $(INC_FILES:.inc=.adoc)
 178
 179 MOTORTEST_TXT_FILES=motortest.txt
 180
 181 MOTORTEST_INC_FILES=\
 182         motortest-configuration.inc \
 183         motortest-installation.inc \
 184         motortest-intro.inc \
 185         motortest-operation.inc
 186
 187 MOTORTEST_ADOC_FILES=$(MOTORTEST_TXT_FILES:.txt=.adoc) $(MOTORTEST_INC_FILES:.inc=.adoc)
 188
 189 TELELAUNCH_TXT_FILES=telelaunch.txt
 190
 191 TELELAUNCH_INC_FILES=\
 192         header.inc \
 193         telelaunch-acknowledgements.inc \
 194         telelaunch-intro.inc \
 195         telelaunch-configuration.inc \
 196         telelaunch-operation.inc \
 197         telelaunch-specs.inc \
 198         telelaunch-updating-firmware.inc \
 199         telelaunch-cables.inc \
 200         telelaunch-troubleshooting.inc
 201
 202 TELELAUNCH_ADOC_FILES=$(TELELAUNCH_TXT_FILES:.txt=.adoc) $(TELELAUNCH_INC_FILES:.inc=.adoc)
 203
 204 TELEGPS_INC_FILES=\
 205         telegps-dedication.inc \
 206         telegps-quick-start.inc \
 207         telegps-using.inc \
 208         telegps-system-operation.inc \
 209         telegps-application.inc \
 210         telegps-specs.inc \
 211         telegps-updating-firmware.inc \
 212         telegps-release-notes.inc \
 213         $(COMMON_INC_FILES)
 214
 215 TELEGPS_TXT_FILES=\
 216         telegps.txt
 217
 218 TELEGPS_ADOC_FILES=$(TELEGPS_TXT_FILES:.txt=.adoc) $(TELEGPS_INC_FILES:.inc=.adoc)
 219
 220 MICROPEAK_TXT_FILES=\
 221         micropeak.txt
 222
 223 MICROPEAK_INC_FILES=
 224
 225 MICROPEAK_ADOC_FILES=$(MICROPEAK_TXT_FILES:.txt=.adoc) $(MICROPEAK_INC_FILES:.inc=.adoc)
 226
 227 EASYMINI_TXT_FILES=\
 228         easymini.txt
 229
 230 EASYMINI_INC_FILES=$(INC_FILES) easymini-release-notes.inc
 231
 232
 233 EASYMINI_ADOC_FILES=$(EASYMINI_TXT_FILES:.txt=.adoc) $(EASYMINI_INC_FILES:.inc=.adoc)
 234
 235 OUTLINE_TXT_FILES=\
 236         easymega-outline.txt \
 237         easymini-outline.txt \
 238         telemega-outline.txt \
 239         telemetrum-outline.txt \
 240         telemini-v1-outline.txt \
 241         telemini-v3-outline.txt \
 242         telegps-outline.txt
 243
 244 OUTLINE_ADOC_FILES=$(OUTLINE_TXT_FILES:.txt=.adoc)
 245
 246 OUTLINE_PDF_FILES=$(OUTLINE_TXT_FILES:.txt=.pdf)
 247
 248 SVG=\
 249         easymini.svg \
 250         telemega.svg \
 251         telemetrum.svg \
 252         telemini-v1.svg \
 253         telemini-v3.svg \
 254         easymega.svg
 255
 256 RELNOTES_HTML=$(RELNOTES_INC:.inc=.html)
 257
 258 ONEFILE_TXT_FILES=\
 259         altos.txt \
 260         companion.txt \
 261         telemetry.txt \
 262         map-loading.txt
 263
 264 ONEFILE_ADOC_FILES=$(ONEFILE_TXT_FILES:.txt=.adoc)
 265 ONEFILE_PDF_FILES=$(ONEFILE_TXT_FILES:.txt=.pdf)
 266 ONEFILE_HTML_FILES=$(ONEFILE_TXT_FILES:.txt=.html)
 267
 268 AM_HTML=am.html
 269
 270 PUBLISH_HTML=altusmetrum.html micropeak.html telegps.html easymini.html motortest.html telelaunch.html $(ONEFILE_HTML_FILES)
 271
 272 HTML=$(PUBLISH_HTML) $(RELNOTES_HTML)
 273
 274 if ASCIIDOCTOR_PDF
 275 PDF=altusmetrum.pdf micropeak.pdf telegps.pdf easymini.pdf motortest.pdf telelaunch.pdf $(ONEFILE_PDF_FILES) \
 276         $(OUTLINE_PDF_FILES)
 277 endif
 278
 279 MAP_DOT_FILES=map-loading.dot
 280 MAP_SVG_FILES=$(MAP_DOT_FILES:.dot=.svg)
 281 STYLESHEET=am.css am-notoc.css
 282
 283 FONTS=\
 284         fonts/DejaVuSansMono-BoldOblique.ttf \
 285         fonts/DejaVuSansMono-Bold.ttf \
 286         fonts/DejaVuSansMono-Oblique.ttf \
 287         fonts/DejaVuSansMono.ttf \
 288         fonts/OpenSans-Light.ttf \
 289         fonts/OpenSans-LightItalic.ttf \
 290         fonts/OpenSans-Regular.ttf \
 291         fonts/OpenSans-Italic.ttf \
 292         fonts/OpenSans-Semibold.ttf \
 293         fonts/OpenSans-SemiboldItalic.ttf
 294
 295 ICONS=\
 296         images/icons/caution.svg \
 297         images/icons/important.svg \
 298         images/icons/note.svg \
 299         images/icons/tip.svg \
 300         images/icons/warning.svg
 301
 302 PDF_CONFIG_FILES=altusmetrum-theme.yml
 303 HTML_CONFIG_FILES=
 304
 305 PUBLISH_DOC=$(PUBLISH_HTML) $(PDF) $(IMAGES) $(MAP_SVG_FILES) $(STYLESHEET)
 306
 307 DOC=$(HTML) $(PDF) $(IMAGES) $(MAP_SVG_FILES) $(STYLESHEET)
 308
 309 SUFFIXES = .dot .svg .inc .txt .adoc .pdf .html
 310
 311 ATTRIBUTES=--attribute="revdate=$(DOC_DATE)" --attribute="version=$(VERSION)"
 312
 313 .dot.svg:
 314         dot -Tsvg -o$@ $*.dot
 315
 316 .txt.adoc:
 317         sed -e 's/^[    ]*//' -e 's/^\\//' $*.txt > $@
 318
 319 .inc.adoc:
 320         sed -e 's/^[    ]*//' -e 's/^\\//' $*.inc > $@
 321
 322 .adoc.html:
 323         asciidoctor $(ATTRIBUTES) -b html5 $*.adoc
 324
 325 .adoc.pdf:
 326         asciidoctor-pdf $(ATTRIBUTES) -a optimize $*.adoc
 327
 328 all:    $(HTML) $(PDF)
 329
 330 map-loading.adoc: $(MAP_SVG_FILES)
 331
 332 altusmetrum.pdf altusmetrum.html: $(ADOC_FILES) $(IMAGES)
 333
 334 motortest.pdf motortest.html: $(MOTORTEST_ADOC_FILES) $(IMAGES)
 335
 336 telelaunch.pdf telelaunch.html: $(TELELAUNCH_ADOC_FILES) $(IMAGES)
 337
 338 telegps.html telegps.pdf: $(TELEGPS_ADOC_FILES) $(IMAGES)
 339
 340 micropeak.pdf micropeak.html: $(MICROPEAK_ADOC_FILES) $(IMAGES)
 341
 342 easymini.pdf easymini.html: $(EASYMINI_ADOC_FILES) $(IMAGES)
 343
 344 telemini-v1-outline.pdf: telemini-v1-outline.txt telemini-v1.svg
 345
 346 telemini-v3-outline.pdf: telemini-v3-outline.txt telemini-v3.svg
 347
 348 install:        all
 349
 350 WEB_ROOT=/home/bdale/web/
 351
 352 publish:        $(PUBLISH_DOC) $(FONTS) $(ICONS)
 353         cp -a $(PUBLISH_DOC) $(WEB_ROOT)/altusmetrum/AltOS/doc/
 354         mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/
 355         cp $(FONTS) $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/
 356         mkdir -p $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/
 357         cp $(ICONS) $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/
 358         (cd $(WEB_ROOT)/altusmetrum ; \
 359          git add $(WEB_ROOT)/altusmetrum/AltOS/doc/* ; \
 360          git add $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* ; \
 361          git add $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons/* ;\
 362          echo "update docs" | \
 363          git commit -F - $(WEB_ROOT)/altusmetrum/AltOS/doc/* $(WEB_ROOT)/altusmetrum/AltOS/doc/fonts/* $(WEB_ROOT)/altusmetrum/AltOS/doc/images/icons ; \
 364          git push)
 365
 366 publish-keithp: am.html $(DOC) $(FONTS)
 367         ssh keithp.com 'mkdir -p ~keithp/public_html/altos/fonts ~keithp/public_html/altos/images/icons'
 368         scp -p am.html $(DOC) keithp.com:~keithp/public_html/altos
 369         scp -p $(FONTS) keithp.com:~keithp/public_html/altos/fonts
 370         scp -p $(ICONS) keithp.com:~keithp/public_html/altos/images/icons
 371
 372 clean:
 373         rm -f am.html $(HTML) $(PDF) $(ADOC_FILES) $(TELEGPS_ADOC_FILES) $(MICROPEAK_ADOC_FILES) $(TELELAUNCH_ADOC_FILES) $(MOTORTEST_ADOC_FILES)
 374
 375 distclean: clean
 376         rm -f $(HTML) $(PDF)
 377
 378 $(PDF): $(PDF_CONFIG_FILES)
 379 $(HTML): $(HTML_CONFIG_FILES)
 380
 381 am.html: Makefile make-am-html $(HTML)
 382         sh ./make-am-html $(HTML) > $@