Mercurial > p > roundup > code

annotate website/www/Makefile @ 8263:78b13272d41b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: link to Client and TemplatingUtils class/method docstrings pydoc.txt: new page. Has two example autodoc invocations: automethod and autoclass. docs.txt Added pydoc.txt as a hidden page in a new toc in docs.txt. Added includehidden in toc directive.Not sure what it does, but was part of a recipie to hide the pydoc from the main TOC. conf.py: added sphinx.ext.autodoc to get it pulling in the docs. reference.txt: added references to the pydoc using :py:meth: for templating utils methods like set-http_response and :py:class: for Client as the existing docs referenced the docstrings. Changed table formatting for the TemplatingUtils methods from table to list-table. The length of the references to the methods was too large to exist in the first column of a drawn table. For right now the pydoc stuff is only referenced via links from the main docs. Currently it is ugly, but the additional info on tempating utils and their arguments can be helpful. Added sphin
author John Rouillard <rouilj@ieee.org>
date Tue, 07 Jan 2025 23:00:35 -0500
parents d6b447de4f59
children 8824c81cc431
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"
8063
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
14 @echo " sourceforge_home_sync sync html directory to"
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
15 @echo " sourceforge:~/roundup_docs"
7494
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
16 @echo " clean remove all produced files"
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
17 clean:
8063
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
18 -rm -rf $(TMP) $(HTML) docs COPYING.txt templates.zip
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
19
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
20 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
21 ln -s ../../doc ./docs
4703
8e34362a14f7 issue2550774: Fix generating the website documentation
John Kristensen <john@jerrykan.com>
parents: 4609
diff changeset
22 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
23
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
24 # 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
25 # fix that in postprocess
6668
4eee1aa1103e reimplment meta opengraph removed in changeset 6628:2bb6d7baa47d
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
26 # also sed index.html to properly format meta og:... entries.
8064
d6b447de4f59 docs: set up for release documentation.
John Rouillard <rouilj@ieee.org>
parents: 8063
diff changeset
27 html: docs
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6668
diff changeset
28 rm -rf html
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
29 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
30 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
31 # install searchtools.js into search page.
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6374
diff changeset
32 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
33 # 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
34 # opengraph tags
6811
075a2f6d703b fix opengraph meta tags name should be property.
John Rouillard <rouilj@ieee.org>
parents: 6763
diff changeset
35 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
36 -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
37 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
38 mkdir html/signatures && cp signatures/*.asc html/signatures
7787
2ab234484708 docs: add older docs and link them from a Sphinx controlled doc
John Rouillard <rouilj@ieee.org>
parents: 7494
diff changeset
39 cp --no-clobber -r docs/html_extra/. html/docs/.
8044
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
40 cp htaccess html/.htaccess
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
41 @echo; \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
42 l=$$(find html -name '*.orig' -o -name '*~' | tee /dev/tty | wc -l);\
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
43 if [ $$l -ne 0 ]; then echo "Garbage files found" && false; fi
8063
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
44 if [ -e templates.zip ]; then cp templates.zip \
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
45 html/CVE-2024-39124-templates.zip; fi
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
46
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
47 linkcheck:
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
48 mkdir -p $(TMP)/linkcheck $(TMP)/doctrees
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
49 sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
50 @echo
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
51 @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
52 "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
53
8063
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
54 templates.zip:
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
55 rm -f templates.zip
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
56 (cd ../../share/roundup; hg status -A templates | \
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
57 sed -ne '/^[AMC]/s/^..//p' | sort | zip -@ - ) > templates.zip
6d4b5005abf2 docs: changes to website docs to announce CVE's
John Rouillard <rouilj@ieee.org>
parents: 8044
diff changeset
58
7445
abc2ec25b3d1 add target to push to sourceforge dev_docs area.
John Rouillard <rouilj@ieee.org>
parents: 7428
diff changeset
59 sourceforge_dev_sync:
8044
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
60 # --no-times makes _images/* and other files sync over every time
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
61 # so docs_backup-... is complete with all files and can be served
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
62 # as the docs tree. Without --no-times _static, _images and other
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
63 # directories are missing from the backup directory.
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
64 # Exclude docs_backup so it won't be deleted from sourceforge
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
65 # since:
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
66 # --delete-exclude
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
67 # IS NOT (and must not be) SET
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
68 read -p "sync to dev_docs y/N? " resp; echo "$$resp" | grep -i "^y"
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
69 rsync -av --no-times --delete --exclude 'docs_backup*' \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
70 --backup --backup-dir docs_backup-`date --iso-8601=seconds` \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
71 html/. \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
72 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
73
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
74 sourceforge_prod_sync:
022b7112c171 Add target to push production www docs.
John Rouillard <rouilj@ieee.org>
parents: 7445
diff changeset
75 read -p "sync to production y/N? " resp; echo "$$resp" | grep -i "^y"
8044
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
76 rsync -av --no-times --delete --exclude 'docs_backup*' \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
77 --backup --backup-dir docs_backup-`date --iso-8601=seconds` \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
78 html/. \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
79 web.sourceforge.net:/home/project-web/roundup/htdocs/.
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
80
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
81 sourceforge_home_sync:
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
82 read -p "sync to home y/N? " resp; echo "$$resp" | grep -i "^y"
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
83 rsync -av --no-times --delete --exclude 'docs_backup*' \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
84 --backup --backup-dir docs_backup-`date --iso-8601=seconds` \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
85 html/. \
f9eaaa63fda2 build: update website build to sync built files
John Rouillard <rouilj@ieee.org>
parents: 7787
diff changeset
86 web.sourceforge.net:roundup_docs/.
Roundup Issue Tracker: http://roundup-tracker.org/