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