diff options
author | Nick Mathewson <nickm@torproject.org> | 2023-10-17 10:25:18 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2023-10-17 10:25:18 -0400 |
commit | cd9263feb0c835b059058b6f6757e64706a457c7 (patch) | |
tree | 43d8a1a515cff5d0281b01863cda67b4f579dac1 /mdbook/spec/make_redirects.py | |
parent | 679c59fbfb449f90bc9c9a7c4f9fac45c0d1b995 (diff) | |
download | torspec-cd9263feb0c835b059058b6f6757e64706a457c7.tar.gz torspec-cd9263feb0c835b059058b6f6757e64706a457c7.zip |
Add (and run) script to auto-regenerate permalink redirects.
This deliberately doesn't make any changes in the current formatting
or targets (yet); that can come later. It uses the existing yaml
format and file.
Diffstat (limited to 'mdbook/spec/make_redirects.py')
-rwxr-xr-x | mdbook/spec/make_redirects.py | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/mdbook/spec/make_redirects.py b/mdbook/spec/make_redirects.py new file mode 100755 index 0000000..c582505 --- /dev/null +++ b/mdbook/spec/make_redirects.py @@ -0,0 +1,58 @@ +#!/usr/bin/env python3 + +import yaml, os, re, sys + +def update_file(fname, start_marker, end_marker, replacement): + content = list(open(fname, 'r').readlines()) + startline = content.index(start_marker) + endline = content.index(end_marker) + assert endline > startline + content[startline+1:endline] = replacement + + with open(fname+".tmp", 'w') as f: + f.write("".join(content)) + os.rename(fname+".tmp", fname) + +BOOK_START = "# BEGIN AUTO-GENERATED REDIRECTS\n" +BOOK_END = "# END AUTO-GENERATED REDIRECTS\n" + +README_START = "<!-- BEGIN AUTO-GENERATED REDIRECTS -->\n" +README_END = "<!-- END AUTO-GENERATED REDIRECTS -->\n" + +def book_redirects(rs, spec_dir): + lines = [] + for kwd, info in rs.items(): + if os.path.isdir(os.path.join(spec_dir, kwd)): + source = kwd + "/index.html" + else: + source = kwd + target = info['target'] + lines.append( + f'"/{source}" = "{target}"\n' + ) + return "".join(lines) + +def readme_redirects(rs): + lines = [ "<dl>\n" ] + for kwd, info in rs.items(): + target = info['target'] + desc = info['description'] + lines.append(f'<dt><a href="/{kwd}"><code>/{kwd}</code></a></dt>\n') + lines.append(f'<dd><a href="{target}"><code>{target}</code> ({desc})</a></dt>\n') + + lines.append("</dl>\n") + return "".join(lines) + +if __name__ == '__main__': + toplevel = os.path.join(os.path.dirname(sys.argv[0]), "..", "..") + book_fname = os.path.join(toplevel, "mdbook", "spec", "book.toml") + spec_dir = os.path.join(toplevel, "spec") + readme_fname = os.path.join(toplevel, "spec", "README.md") + yaml_fname = os.path.join(toplevel, "mdbook", "spec", "spec-redirects.yaml") + + rs = yaml.load(open(yaml_fname), yaml.Loader)['redirects'] + + update_file(book_fname, BOOK_START, BOOK_END, book_redirects(rs, spec_dir)) + update_file(readme_fname, README_START, README_END, readme_redirects(rs)) + + |