Mercurial > p > roundup > code
view website/www/Makefile @ 7744:6985f0ff3df3
doc: document lib, fix formating/example
Add lib as an optional directory in a template.
Make config_ini.ini example an actual code block using the file from
the jinja2 template.
Format the TEMPLATE-INFO.txt example as plain text (it was
highlighting words like 'in' and 'with'). Also move the whole example
under the bullet item, it was outside of the list. Reformat the input
text to be less than 80 characters.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 26 Feb 2024 11:23:36 -0500 |
| parents | 022b7112c171 |
| children | 2ab234484708 |
line wrap: on
line source
TMP := _tmp HTML := html .PHONY: help clean html linkcheck help: @echo "Please use \`make <target>' where <target> is one of" @echo " html to make standalone HTML files" @echo " linkcheck to check all external links for integrity" @echo " sourceforge_prod_sync sync html directory to sourceforce" @echo " production website" @echo " sourceforge_dev_sync sync html directory to sourceforce" @echo " /dev_docs subdirectory" @echo " clean remove all produced files" clean: -rm -rf $(TMP) $(HTML) docs COPYING.txt docs: ln -s ../../doc ./docs ln -s ../../COPYING.txt # after upgrade to sphinx 1.8.5, search.html is missing load of searchtools. # fix that in postprocess # also sed index.html to properly format meta og:... entries. html: docs rm -rf html mkdir -p $(TMP)/doctrees $(HTML) sphinx-build -n -W -b html -d $(TMP)/doctrees . $(HTML) # install searchtools.js into search page. 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 # sphinx inserts \: for : in meta tags. Get rid of the \ in # opengraph tags sed -i -e '/<meta/s/og\\:/og:/' \ -e '/<meta/s/name="og:/property="og:/' html/index.html cp robots.txt html/robots.txt mkdir html/signatures && cp signatures/*.asc html/signatures linkcheck: mkdir -p $(TMP)/linkcheck $(TMP)/doctrees sphinx-build -b linkcheck -d $(TMP)/doctrees . $(TMP)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in .build/linkcheck/output.txt." sourceforge_dev_sync: rsync -av html/. web.sourceforge.net:/home/project-web/roundup/htdocs/dev_docs/. sourceforge_prod_sync: read -p "sync to production y/N? " resp; echo "$$resp" | grep -i "^y" rsync -av html/. web.sourceforge.net:/home/project-web/roundup/htdocs/.
