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