annotate website/www/Makefile @ 6763:d93b441ee778

Handle build issues, update css for mobile I added www.roundup-tracker.org as a property of mine in google search console. It reports bad mobile experience. According to the goatcounter tracker I put in, we get 400 hits from phones/small tablets; 400 from tablets/small laptops and 800 from computer screens. So 1/4 is mobile and 1/2 is not a large computer screen. On mobile (<960px) the left hand menu is stacked on top of the column in mobile sizes. Sub-menu links are spaced apart to make them easier to clkick on with a finger. Same with the table of contents in the documents. The main document content is now full display width (rather than scrunched to the right side of the display). This is just a quick hack, but it should make the docs more usable. As I worked, I found that _static/style.css changes were not being copied into the html build directory when sphinx was rerun. Nuke entire html subdir and rebuild from scratch each time. Also added comments to Makefile. Also robots.txt was being added as extra_html by sphinx, but it causes a missing from TOC error that exits the build (when using -W). Since exiting on warning is better, I changed Makefile to add robots.txt. Removed robots.txt references from conf.py.
author John Rouillard <rouilj@ieee.org>
date Sun, 10 Jul 2022 18:16:13 -0400
parents 4eee1aa1103e
children 075a2f6d703b
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"
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
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
18 # 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
19 # fix that in postprocess
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
20 # 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
21 html: docs
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
22 rm -rf html
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
23 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
24 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
25 # install searchtools.js into search page.
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
26 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
27 # 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
28 # opengraph tags
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
29 sed -i -e '/<meta/s/og\\:/og:/' html/index.html
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
30 cp robots.txt html/robots.txt
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
31
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
32 linkcheck:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
33 mkdir -p $(TMP)/linkcheck $(TMP)/doctrees
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
34 sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
35 @echo
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
36 @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
37 "or in .build/linkcheck/output.txt."

Roundup Issue Tracker: http://roundup-tracker.org/