tools: generate stdlib doc with the git plugin enabled
[nit.git] / Makefile
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2008 Jean Privat <jean@pryen.org>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 NITCOPT=
18
19 all: tools doc/stdlib/index.html
20
21 docs: doc/stdlib/index.html doc/nitc/index.html
22 #cd doc; make
23
24 tools:
25 cd src; make
26
27 bin/nitdoc:
28 cd src; make ../bin/nitdoc
29
30 doc/stdlib/index.html: bin/nitdoc
31 @echo '***************************************************************'
32 @echo '* Generate doc for NIT standard library *'
33 @echo '***************************************************************'
34 bin/nitdoc lib/*.nit $$(find lib/*/*.nit -maxdepth 0 -type f ) -d doc/stdlib \
35 --custom-title "Nit Standard Library" \
36 --custom-menu-items "<li><a href=\"http://nitlanguage.org/\">Nitlanguage.org</a></li>" \
37 --custom-overview-text "<p>Documentation for the standard library of Nit<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
38 --custom-footer-text "Nit standard library. Version $$(git describe)." \
39 --github-upstream "privat:nit:master" \
40 --github-base-sha1 "$$(git rev-parse HEAD)" \
41 --github-gitdir "." \
42 --source "https://github.com/privat/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L"
43
44 doc/nitc/index.html: bin/nitdoc
45 bin/nitdoc src/nit.nit src/nitmetrics.nit src/nitg.nit src/nitx.nit src/nitunit.nit src/nitlight.nit src/dbgcli.nit src/netdbg.nit -d doc/nitc \
46 --private \
47 --custom-title "Nit Compilers and Tools" \
48 --custom-menu-items "<li><a href=\"http://nitlanguage.org/\">Nitlanguage.org</a></li>" \
49 --custom-overview-text "<p>Documentation for the Nit tools<br/>Version $$(git describe)<br/>Date: $$(git show --format="%cd" | head -1)</p>" \
50 --custom-footer-text "Nit tools. Version $$(git describe)." \
51 --github-upstream "privat:nit:master" \
52 --github-base-sha1 "$$(git rev-parse HEAD)" \
53 --github-gitdir "." \
54 --source "https://github.com/privat/nit/blob/$$(git rev-parse HEAD)/%f#L%l-%L"
55
56 clean:
57 rm -rf -- .nit_compile 2> /dev/null || true
58 cd c_src; make clean
59 cd src; make clean
60 cd doc; make clean
61 cd tests; make clean
62
63 distclean: clean
64 rm -rf -- bin/nitdoc bin/nits doc/stdlib 2> /dev/null || true
65 cd c_src; make distclean
66 cd src/parser; make distclean
67 cd doc; make distclean
68 cd tests; make distclean