Mercurial > p > roundup > code

annotate website/www/Makefile @ 7494:022b7112c171

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add target to push production www docs. Sourceforge is stuck at python2 and old version of sphinx. Add makefile target to allow making docs with newer sphinx and sync it into place.
author John Rouillard <rouilj@ieee.org>
date Thu, 15 Jun 2023 20:55:03 -0400
parents abc2ec25b3d1
children 2ab234484708
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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"
7494
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
10 @echo " sourceforge_prod_sync sync html directory to sourceforce"
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
11 @echo " production website"
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
12 @echo " sourceforge_dev_sync sync html directory to sourceforce"
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
13 @echo " /dev_docs subdirectory"
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
14 @echo " clean remove all produced files"
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
15 clean:
4703
8e34362a14f7 issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents: 4609
diff changeset
16 -rm -rf $(TMP) $(HTML) docs COPYING.txt
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
17
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
18 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
19 ln -s ../../doc ./docs
4703
8e34362a14f7 issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents: 4609
diff changeset
20 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
21
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
22 # after upgrade to sphinx 1.8.5, search.html is missing load of searchtools.
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
23 # fix that in postprocess
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
24 # also sed index.html to properly format meta og:... entries.
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
25 html: docs
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
26 rm -rf html
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
27 mkdir -p $(TMP)/doctrees $(HTML)
6374
977e0ef08406 Enable nitpick mode and warnings as errors for html generation
John Rouillard <rouilj@ieee.org>
parents: 4703
diff changeset
28 sphinx-build -n -W -b html -d $(TMP)/doctrees . $(HTML)
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
29 # install searchtools.js into search page.
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
30 grep 'searchtools.js' html/search.html || sed -i -e '/language_data.js/s#</script>#</script>\n <script type="text/javascript" src="_static/searchtools.js"></script>#' html/search.html
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
31 # sphinx inserts \: for : in meta tags. Get rid of the \ in
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
32 # opengraph tags
6811
075a2f6d703b fix opengraph meta tags name should be property.
John Rouillard <rouilj@ieee.org>
parents: 6763
diff changeset
33 sed -i -e '/<meta/s/og\\:/og:/' \
075a2f6d703b fix opengraph meta tags name should be property.
John Rouillard <rouilj@ieee.org>
parents: 6763
diff changeset
34 -e '/<meta/s/name="og:/property="og:/' html/index.html
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
35 cp robots.txt html/robots.txt
7428
186956a87ad7 issue2551279 - GPG support removed from pypi - rewrite pgp signature validation.
John Rouillard <rouilj@ieee.org>
parents: 6811
diff changeset
36 mkdir html/signatures && cp signatures/*.asc html/signatures
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
37
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
38 linkcheck:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
39 mkdir -p $(TMP)/linkcheck $(TMP)/doctrees
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
40 sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
41 @echo
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
42 @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
43 "or in .build/linkcheck/output.txt."
7445
abc2ec25b3d1 add target to push to sourceforge dev_docs area.
John Rouillard <rouilj@ieee.org>
parents: 7428
diff changeset
44
abc2ec25b3d1 add target to push to sourceforge dev_docs area.
John Rouillard <rouilj@ieee.org>
parents: 7428
diff changeset
45 sourceforge_dev_sync:
abc2ec25b3d1 add target to push to sourceforge dev_docs area.
John Rouillard <rouilj@ieee.org>
parents: 7428
diff changeset
46 rsync -av html/. web.sourceforge.net:/home/project-web/roundup/htdocs/dev_docs/.
7494
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
47
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
48 sourceforge_prod_sync:
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
49 read -p "sync to production y/N? " resp; echo "$$resp" | grep -i "^y"
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
50 rsync -av html/. web.sourceforge.net:/home/project-web/roundup/htdocs/.
Roundup Issue Tracker: http://roundup-tracker.org/