Mercurial > p > roundup > code
annotate website/www/Makefile @ 7340:7b9bddda9d2d
Add support for demo mode in docker.
roundup/demo.py
Make changes to allow exposed port in docker to be specified
separately from the port that demo mode binds to. Also permit
bind address specification as well.
roundup/scripts/roundup_demo.py:
Update required by changes in demo.py. Also move away from
positional arguments to prefer flag arguments. Required for
passing port and host specification. Flake8 fixes.
share/man/man1/roundup-demo.1
Document use of option flags rather than positional
params. Other cleanups.
doc/installation.txt:
Document new docker modes: demo, shell and admin.
Update docs:
overview section - reorg, added template info
for the impatient section - added docker demo mode reference,
more docs on top level demo.py use.
new section on docker demo mode
removed getting roundup section. folded into installing roundup.
also prior for the impatient section describes how to download.
install via pip in venv recommended supported method
document all provided templates. not just minimal and classic.
added index references.
move sections around, decreased sectin depth, reformatting
scripts/Docker/roundup_healthcheck:
When running roundup-demo, there is no tracker spec. So default to
demo if no tracker=directory args found. Prevent's docker from
reporting an unhealthy container when running demo.
scripts/Docker/roundup_start:
implement demo, shell, admin docker modes.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 May 2023 09:43:53 -0400 |
| parents | 075a2f6d703b |
| children | 186956a87ad7 |
| 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 |
|
6811
075a2f6d703b
fix opengraph meta tags name should be property.
John Rouillard <rouilj@ieee.org>
parents:
6763
diff
changeset
|
29 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
|
30 -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
|
31 cp robots.txt html/robots.txt |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
32 |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
33 linkcheck: |
|
4035
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
34 mkdir -p $(TMP)/linkcheck $(TMP)/doctrees |
|
e4950073153f
Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
4022
diff
changeset
|
35 sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck |
|
4022
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
36 @echo |
|
d62831da3941
svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff
changeset
|
37 @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
|
38 "or in .build/linkcheck/output.txt." |
