Mercurial > p > roundup > code
annotate website/www/Makefile @ 4703:8e34362a14f7
issue2550774: Fix generating the website documentation
- the COPYING.txt file needs to be symlinked into website/www/ so the
documentation can be generated correctly
- add website/www/COPYING.txt to the .hgignore file so the symlinked version
does not get accidentally committed to the repository
- the website documentation Makefile 'clean' removes the symlinks and the
generated html to return things back to the original state, which is what
should happen on a 'clean'
| author | John Kristensen <john@jerrykan.com> |
|---|---|
| date | Sun, 16 Dec 2012 13:18:11 +1100 |
| parents | 9ed905019303 |
| children | 977e0ef08406 |
| rev | line source |
|---|---|
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
1 TMP := _tmp |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
2 HTML := html |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
3 |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
4 .PHONY: help clean html linkcheck |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
5 |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
6 help: |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
7 @echo "Please use \`make <target>' where <target> is one of" |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
8 @echo " html to make standalone HTML files" |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
9 @echo " linkcheck to check all external links for integrity" |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
10 |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
11 clean: |
|
4703
8e34362a14f7
issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents:
4609
diff
changeset
|
12 -rm -rf $(TMP) $(HTML) docs COPYING.txt |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
4609
9ed905019303
website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents:
4553
diff
changeset
|
14 docs: |
|
9ed905019303
website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents:
4553
diff
changeset
|
15 ln -s ../../doc ./docs |
|
4703
8e34362a14f7
issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents:
4609
diff
changeset
|
16 ln -s ../../COPYING.txt |
|
4609
9ed905019303
website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents:
4553
diff
changeset
|
17 |
|
9ed905019303
website docs: Added link to Makefile and adapted the hg command needed for sf.
Bernhard Reiter <bernhard@intevation.de>
parents:
4553
diff
changeset
|
18 html: docs |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
19 mkdir -p $(TMP)/doctrees $(HTML) |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
20 sphinx-build -b html -d $(TMP)/doctrees . $(HTML) |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
21 |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
22 linkcheck: |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
23 mkdir -p $(TMP)/linkcheck $(TMP)/doctrees |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
24 sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
25 @echo |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
26 @echo "Link check complete; look for any errors in the above output " \ |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
27 "or in .build/linkcheck/output.txt." |
