| Zack Williams | 144027f | 2017-09-25 18:01:47 -0700 | [diff] [blame^] | 1 | # Makefile for building CORD docs site, guide.opencord.org |
| 2 | # Building docs requires the following tools: |
| 3 | # - Gitbook toolchain: https://toolchain.gitbook.com/setup.html |
| 4 | # - NPM (for Gitbook and Swagger) |
| 5 | # - Python (for build glossary script) |
| 6 | # - linkchecker (for test target) http://wummel.github.io/linkchecker/ |
| 7 | |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 8 | default: serve |
| Matteo Scandolo | f8cd29f | 2017-09-07 13:57:26 -0700 | [diff] [blame] | 9 | |
| Zack Williams | 2d04b0d | 2017-09-25 14:19:55 -0700 | [diff] [blame] | 10 | # use bash for pushd/popd, and to fail if commands within a pipe fail |
| 11 | SHELL = bash -o pipefail |
| 12 | |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 13 | GENERATED_DOCS = build_glossary.md |
| llp | bd786de | 2017-07-07 15:57:27 -0700 | [diff] [blame] | 14 | |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 15 | serve: setup |
| Matteo Scandolo | 8a76f92 | 2017-08-29 14:02:58 -0700 | [diff] [blame] | 16 | gitbook serve |
| llp | 1827698 | 2017-07-11 11:28:47 -0700 | [diff] [blame] | 17 | |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 18 | build: setup |
| 19 | gitbook build |
| 20 | |
| Zack Williams | 144027f | 2017-09-25 18:01:47 -0700 | [diff] [blame^] | 21 | setup: clean platform-install cord-tester profiles xos xos-gui xos-tosca swagger $(GENERATED_DOCS) |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 22 | gitbook init |
| 23 | gitbook install |
| 24 | |
| Zack Williams | 144027f | 2017-09-25 18:01:47 -0700 | [diff] [blame^] | 25 | test: linkcheck |
| 26 | |
| 27 | linkcheck: build |
| 28 | linkchecker -a _book/ |
| 29 | |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 30 | platform-install: |
| 31 | ln -s ../platform-install/docs platform-install |
| 32 | |
| Zack Williams | 144027f | 2017-09-25 18:01:47 -0700 | [diff] [blame^] | 33 | cord-tester: |
| 34 | ln -s ../../test/cord-tester/docs cord-tester |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 35 | |
| 36 | profiles: |
| 37 | ln -s ../../orchestration/profiles profiles |
| 38 | |
| 39 | xos: |
| 40 | ln -s ../../orchestration/xos/docs xos |
| 41 | |
| 42 | xos-gui: |
| 43 | ln -s ../../orchestration/xos-gui/docs xos-gui |
| 44 | |
| 45 | xos-tosca: |
| 46 | ln -s ../../orchestration/xos-tosca/docs xos-tosca |
| 47 | |
| 48 | build_glossary.md: scripts/descriptions.md scripts/defaults.md.j2 scripts/defaultsdoc.py scripts/markedyaml.py |
| 49 | python scripts/defaultsdoc.py -o build_glossary.md |
| 50 | |
| 51 | swagger: xos |
| Matteo Scandolo | f8cd29f | 2017-09-07 13:57:26 -0700 | [diff] [blame] | 52 | pushd ../../orchestration/xos/docs/; make swagger_docs; popd; |
| 53 | |
| Zack Williams | 1b96a95 | 2017-07-17 16:48:01 -0700 | [diff] [blame] | 54 | clean: |
| 55 | rm -rf $(GENERATED_DOCS) |
| 56 | rm -rf _book |
| 57 | rm -rf node_modules |
| 58 | rm -f platform-install test profiles xos xos-gui xos-tosca |
| 59 | |