Publish RFCs on https://amaranth-lang.org/rfcs/

Author: whitequark

.github/workflows/deploy.yaml

@@ -0,0 +1,29 @@
+on:
+  push:
+    branches:
+      - main
+name: Deploy
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Check out source code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: Install mdbook
+      run: |
+        mkdir mdbook
+        curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.26/mdbook-v0.4.26-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
+        echo `pwd`/mdbook >> $GITHUB_PATH
+    - name: Generate book
+      run: |
+        ./generate-book.py
+    - name: Publish book
+      uses: JamesIves/github-pages-deploy-action@v4
+      with:
+        repository-name: amaranth-lang/amaranth-lang.github.io
+        ssh-key: ${{ secrets.PAGES_DEPLOY_KEY }}
+        branch: main
+        folder: book/
+        target-folder: rfcs/

.gitignore

@@ -0,0 +1,2 @@
+/src/
+/book/

book.toml

@@ -0,0 +1,12 @@
+[book]
+title = "The Amaranth RFC Book"
+
+[output.html]
+no-section-label = true
+git-repository-url = "https://github.com/amaranth-lang/rfcs"
+
+[output.html.search]
+heading-split-level = 0
+
+[output.html.playground]
+runnable = false

generate-book.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+"""
+This auto-generates the mdBook SUMMARY.md file based on the layout on the filesystem.
+This generates the `src` directory based on the contents of the `text` directory.
+Most RFCs should be kept to a single chapter. However, in some rare cases it
+may be necessary to spread across multiple pages. In that case, place them in
+a subdirectory with the same name as the RFC. For example:
+    0123-my-awesome-feature.md
+    0123-my-awesome-feature/extra-material.md
+It is recommended that if you have static content like images that you use a similar layout:
+    0123-my-awesome-feature.md
+    0123-my-awesome-feature/diagram.svg
+The chapters are presented in sorted-order.
+"""
+
+import os
+import shutil
+import subprocess
+
+def main():
+    if os.path.exists('src'):
+        # Clear out src to remove stale links in case you switch branches.
+        shutil.rmtree('src')
+    os.mkdir('src')
+
+    for path in os.listdir('text'):
+        symlink(f'../text/{path}', f'src/{path}')
+    symlink('../README.md', 'src/introduction.md')
+
+    with open('src/SUMMARY.md', 'w') as summary:
+        summary.write('[Introduction](introduction.md)\n\n')
+        collect(summary, 'text', 0)
+
+    subprocess.call(['mdbook', 'build'])
+
+def collect(summary, path, depth):
+    entries = [e for e in os.scandir(path) if e.name.endswith('.md')]
+    entries.sort(key=lambda e: e.name)
+    for entry in entries:
+        indent = '    '*depth
+        name = entry.name[:-3]
+        link_path = entry.path[5:]
+        summary.write(f'{indent}- [{name}]({link_path})\n')
+        maybe_subdir = os.path.join(path, name)
+        if os.path.isdir(maybe_subdir):
+            collect(summary, maybe_subdir, depth+1)
+
+def symlink(src, dst):
+    if not os.path.exists(dst):
+        os.symlink(src, dst)
+
+if __name__ == '__main__':
+    main()