OpenCores
URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [docs/] [Makefile] - Blame information for rev 62

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 62 zero_gravi
.DEFAULT_GOAL := help
2
 
3
all: pdf html ug-pdf ug-html
4
        mkdir -p public/img/
5
        cp -vr figures/* public/img/
6
 
7
# Generate PDF datasheet
8
pdf:
9
        [ -f revnumber.txt ] && REVNUMBER='-a revnumber='"$$(cat revnumber.txt)" || unset REVNUMBER; \
10
        asciidoctor-pdf $$REVNUMBER \
11
          -a pdf-theme=neorv32-theme.yml \
12
          -r asciidoctor-diagram \
13
          datasheet/main.adoc \
14
          --out-file public/pdf/NEORV32.pdf
15
 
16
# Generate HTML datasheet
17
html:
18
        [ -f revnumber.txt ] && REVNUMBER='-a revnumber='"$$(cat revnumber.txt)" || unset REVNUMBER; \
19
        asciidoctor $$REVNUMBER \
20
          -r asciidoctor-diagram \
21
          datasheet/index.adoc \
22
          --out-file public/index.html
23
 
24
# Generate PDF user guide
25
ug-pdf:
26
        [ -f revnumber.txt ] && REVNUMBER='-a revnumber='"$$(cat revnumber.txt)" || unset REVNUMBER; \
27
        asciidoctor-pdf $$REVNUMBER \
28
          -a pdf-theme=neorv32-theme.yml \
29
          -r asciidoctor-diagram \
30
          userguide/main.adoc \
31
          --out-file public/pdf/NEORV32_UserGuide.pdf
32
 
33
# Generate HTML user guide
34
ug-html:
35
        [ -f revnumber.txt ] && REVNUMBER='-a revnumber='"$$(cat revnumber.txt)" || unset REVNUMBER; \
36
        asciidoctor $$REVNUMBER \
37
          -r asciidoctor-diagram \
38
          userguide/index.adoc \
39
          --out-file public/ug/index.html
40
 
41
# Generate DOXYGEN software documentation
42
doxygen:
43
        doxygen Doxyfile
44
 
45
# Generate revnumber.txt for overriding the revnumber attribute in 'pdf' and/or 'html'
46
revnumber:
47
        if [ `git tag -l | grep nightly` ]; then git tag -d nightly; fi
48
        git describe --long --tags | sed 's#\([^-]*-g\)#r\1#;' > revnumber.txt
49
        cat revnumber.txt
50
 
51
# Build 'pdf' and 'html' in an 'asciidoctor-wavedrom' container
52
container: revnumber
53
        docker run --rm -v /$(shell pwd)://documents/ btdi/asciidoctor make all
54
 
55
# Help
56
help:
57
        @echo "Targets:"
58
        @echo " help    - show this text"
59
        @echo " pdf     - build datasheet as pdf file (public/pdf/NEORV32.pdf)"
60
        @echo " html    - build datasheet as HTML page (public/index.html)"
61
        @echo " ug-pdf  - build user guide as pdf file (public/pdf/NEORV32_UserGuide.pdf)"
62
        @echo " ug-html - build user guide as HTML page (public/ug/index.html)"
63
        @echo " doxygen - build software documentation as HTML page (doxygen_build/html/index.html)"

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.