Commit Graph

41 Commits

Author SHA1 Message Date
Jack Grigg 26f16f44ec Move ZIP source into `zips/` subdirectory
This makes the repo root more approachable for newcomers; the README can
be seen in GitHub immediately instead of after much scrolling.
2024-07-16 18:58:05 +00:00
Jack Grigg 080306b42a Move files rendered for zips.z.cash into a subdirectory
All content that is reachable via links on zips.z.cash is moved into
this directory, so that GitHub Pages can be configured to build the site
from it. This includes non-generated files like CSS that are required
for correct site presentation.
2024-07-16 18:52:47 +00:00
Daira-Emma Hopwood ca22568386 Makefile: fix a bug in local rendering that could include unintended
'zip-*.{md,rst}' files from under the `.git` directory in the index.

Also make the rendering of the "Drafts without assigned ZIP numbers"
section conditional on whether there are any such drafts.

Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
2024-07-01 17:20:36 +01:00
Daira Emma Hopwood 8b8d14ae02 Rename `release` Makefile target to `tag-release`. Make it not require being on main,
but check that the current branch is a descendant of the `origin` remote's `main`, i.e.
pushing to `origin main` would be a fast-forward.

Signed-off-by: Daira Emma Hopwood <daira@jacaranda.org>
2023-12-19 17:43:09 +00:00
Daira Emma Hopwood 871d5652c1 Makefile: `make discard` should discard changes to `README.rst`.
Signed-off-by: Daira Emma Hopwood <daira@jacaranda.org>
2023-03-03 18:37:42 +00:00
Daira Hopwood 954467c15d Update dependency info.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-09-20 10:21:45 +01:00
Daira Hopwood 1c1a42bb27 In protocol/README.rst: Update build dependency documentation for Debian Bullseye,
mention `make linkcheck`, and correct the description of `make all`.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-09-01 13:09:45 +01:00
Daira Hopwood 30ee914674 Makefile: correct a problem with the linkcheck target if pdfs are not built.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-06-22 18:34:38 +01:00
Daira Hopwood 195b8147eb Update links_and_dests.py to support HTML files and rate limiting (part 2).
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2021-09-09 14:58:42 +01:00
Daira Hopwood 766376664a For no good reason at all, wildcard doesn't sort on *some* versions of Gnu make: <https://savannah.gnu.org/bugs/index.php?52076>.
This change isn't semantically necessary, but the `make` output is easier to read if the files are sorted.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-09-15 15:15:01 +01:00
Daira Hopwood bbb2bac1ac Makefile: add 'discard' target, to discard changes to checked-in generated files.
This is useful to avoid conflicts when merging / rebasing / doing 'git stash pop'.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-07-05 17:27:20 +01:00
Daira Hopwood 9acf1b6667 Makefiles: add 'release' targets that perform a protocol spec release.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-07-05 17:27:20 +01:00
Daira Hopwood b9f87da380 Makefile: document perl and sed as dependencies.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-06-15 14:04:24 +01:00
Daira Hopwood 66a41077ca Support writing ZIPs in Markdown, generating the HTML using pandoc.
This has some minor deficiencies in math support and formatting of references.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-05-26 23:06:08 +01:00
Daira Hopwood 92349aa776 Makefile: tweak title generation.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-05-12 15:55:06 +01:00
Daira Hopwood d8951f74f5 Makefile: python3 transition.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-05-12 15:54:17 +01:00
Daira Hopwood 882aeb9aa5 Makefile: HTML generation should depend on edithtml.sh.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-04-22 14:35:00 +01:00
Daira Hopwood 283480c802 Makefile: rebuild index if files have been deleted.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-04-14 13:08:16 +01:00
Daira Hopwood 604532cca1 Makefile: add dot to filename of .Makefile.uptodate
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-04-14 13:06:08 +01:00
Daira Hopwood ef987f67b2 Ensure that changing a Makefile rebuilds everything on the next run.
Also change the default target for protocol/Makefile to not build unconditionally.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-03-10 16:43:19 +00:00
Daira Hopwood 0449b3583e Makefile: remove duplication and refine the rule for considering README.rst out-of-date.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-03-10 13:05:31 +00:00
Daira Hopwood a0aa25c407 Factor out HTML editing from Makefile into edithtml.sh
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-02-25 12:42:17 +00:00
Daira Hopwood 119b7c8ca1 Try to improve consistency of whitespace behaviour for sed on macOS.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-01-24 15:33:58 +00:00
Daira Hopwood 2b62e7574b Move custom stylesheet to css/style.css
Author: copernicus-mogley <ryan@z.cash>
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-01-24 15:33:40 +00:00
copernicus-mogley 25ada6f826 Update Makefile and makeindex.sh to run without errors on MacOS 2020-01-24 15:30:53 +00:00
copernicus-mogley b506217b2b Remove unnecessary stylesheet from second instance and replace with viewport meta tag 2020-01-24 15:30:53 +00:00
copernicus-mogley 0c0d2f04e2 Add viewport meta tag for responsive display 2020-01-24 15:30:53 +00:00
copernicus-mogley fb8dafb3d8 Remove commented-out CSS, unnessary css files and stylesheet tag 2020-01-24 15:30:53 +00:00
nathan d81c846af0 Modify root Makefile to build protocol with the 'all' target; update Docker to include protocol render toolchain. 2020-01-05 12:54:51 -08:00
Daira Hopwood c13faee763 Fix a Makefile bug that could result in the index failing to be regenerated when needed.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-11-17 17:41:37 +00:00
Daira Hopwood 98b01feeb0 Fix links to NU3 ZIPs from index.
(The .rst suffix was getting deleted for all links rather than just relative links as intended.)

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-11-09 17:50:56 +00:00
Daira Hopwood 1db4f4efe1 Use relative links from ZIPs to other ZIPs and the protocol spec.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-11-07 20:28:29 +00:00
Daira Hopwood 4b20dd87bb Really fix links in index.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-11-07 20:00:20 +00:00
Daira Hopwood b25a4e6889 Makefile improvements; delete obsolete index.rst.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-09-03 14:19:25 +01:00
Daira Hopwood 72ca40e99d Fix README.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-24 14:42:31 +01:00
Daira Hopwood 2815bee6f9 Change README from Markdown to rST (for uniformity and to avoid GitHub pages caching problems).
Also regenerate HTML.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-24 14:29:17 +01:00
Daira Hopwood fcdde6f89a Switch from pandoc to rst2html5.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-06 13:58:27 +01:00
Daira Hopwood d90238c971 Add index of ZIPs.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-06 12:41:46 +01:00
Daira Hopwood 3669cb1d79 Style the HTML.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-06 04:19:55 +01:00
Daira Hopwood 4ee74f4322 Markdown didn't work out for ZIPs, try HTML.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-06 01:05:27 +01:00
Daira Hopwood 4c1939cc39 Add Makefile to generate .md files.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2019-08-06 00:47:11 +01:00