generate BEP pages

Author: Remi-Gau

.remarkignore

@@ -1,3 +1,4 @@
 docs/collaboration/bids_github/
 docs/datasets/index.md
 docs/extensions/macros_doc.md
+docs/extensions/beps

data/beps/beps.yml

@@ -572,6 +572,7 @@
 
 -   number: '044'
     title: Stimuli
+    google_doc: https://docs.google.com/document/d/1DoQghbJlQksCHEFs0boT816p3ejX2Hd9l-OWDTXFtV8/edit
     leads:
     -   given-names: Seyed
         family-names: Yahya Shirazi

docs/extensions/beps.md

@@ -2,6 +2,8 @@
 
 You can contribute to ongoing BIDS Extension Proposals (BEPs).
 
+## Active BEPs
+
 Below is a table of currently-active BEPs.
 
 Note that all of the extension ideas that are not backwards compatible and thus will have to wait for BIDS 2.0 are listed on the
@@ -25,7 +27,7 @@ https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippets-
 
 {{ MACROS___generate_beps_table(file="beps_completed.yml", type="completed") }}
 
-<br>
+## Others
 
 Some proposals that set out to extend the BIDS specification have instead lead to other outcomes such as:
 

makefile

@@ -3,7 +3,7 @@ all: update
 serve: update
 	mkdocs serve -a localhost:8080
 
-update: update_from_spec update_contributors update_datasets_examples tmp_figures
+update: update_from_spec update_contributors update_datasets_examples tmp_figures update_bep_pages
 
 package.json:
 	npm install `cat npm-requirements.txt`
@@ -23,6 +23,9 @@ update_datasets_examples:
 	@echo "  ----------------------------------  "
 	python data/datasets/examples/tools/print_dataset_listing.py docs/datasets/index.md
 
+update_bep_pages:
+	@echo "  ----------------------------------  "
+	python tools/build/generate_bep_pages.py
 
 # Figures
 .PHONY: tmp/affiliations.html tmp/bids_timeline.html tmp/citation_per_year.html tmp/openneuro_data_growth.html

templates/bep_page_md.jinja

@@ -0,0 +1,75 @@
+---
+hide:
+    - navigation
+    - toc
+---
+
+# BEP {{ bep.number }}: {% if bep.display %} {{ bep.display }} {% else %} {{ bep.title }} {% endif %}
+
+{% if bep.communication_channel %}
+!!! note
+
+    Get in touch with people working on this BIDS extension: [{{ bep.communication_channel }}]({{ bep.communication_channel }})
+{% endif %}
+
+{% if bep.pull_request %}
+**Pull request**: [{{ bep.pull_request }}]({{ bep.pull_request }} )
+{% else %}
+**Google doc**:  [{{ bep.google_doc }}]({{ bep.google_doc }} )
+{% endif %}
+
+## Content
+
+{% for content in bep.content %}
+- {{ content }}
+{% endfor %}
+
+## Lead(s)
+
+{% for person in bep.leads %}
+{% if person.email %}
+-   [{{ person["given-names"] }} {{ person["family-names"] }}](mailto:{{ person.email }})
+{% else %}
+-   {{ person["given-names"] }} {{ person["family-names"] }}
+{% endif %}
+{% endfor %}
+
+{% if bep.status %}
+## Status
+
+{% for item in bep.status %}
+-   {{ item }}
+{% endfor %}
+{% endif %}
+
+{% if bep.blocking %}
+## Blockers
+
+{% for item in bep.blocking %}
+-   {{ item }}
+{% endfor %}
+{% endif %}
+
+{% if bep.bids_maintainers %}
+## BIDS maintainers
+
+{% for person in bep.bids_maintainers %}
+-   {{ person["given-names"] }} {{ person["family-names"] }}
+{% endfor %}
+{% endif %}
+
+## Preview
+
+<iframe
+{% if bep.html_preview %}
+    src="{{ bep.html_preview }}"
+{% else %}
+    src="{{ bep.google_doc }}"
+{% endif %}
+    width="100%"
+    height="1024"
+    frameborder="0"
+    marginheight="0"
+    marginwidth="0">
+Loading…
+</iframe>

templates/beps_table_md.jinja

@@ -1,13 +1,10 @@
-{% if type == "completed" %}
-| Extension  | Title | Content | Lead(s) |
-| :--------: | :---- | :-----  | :-----  |
-{% elif type == "other" %}
+{% if type == "other" %}
 | Extension  | Title | Content | Lead(s) | Outcome |
 | :--------: | :---- | :-----  | :-----  | :------ |
 {% else %}
-| Extension  | Title | Content | Lead(s) | Last update | Problems |
-| :--------: | :---- | :-----  | :-----  | :---------- | :------- |
+| Extension  | Title | Content | Lead(s) |
+| :--------: | :---- | :-----  | :-----  |
 {% endif %}
 {% for bep in include %}
-| [BEP {{ bep.number }}](./beps/bep_{{ bep.number }}.html) | {% if bep.display %} {{ bep.display }} {% else %} {{ bep.title }} {% endif %} | {% for content in bep.content %} {{ content }} {% endfor %} | {% for person in bep.leads %} {% if person.email %} [{{ person["given-names"] }} {{ person["family-names"] }}](mailto:{{ person.email }}) {% else %} {{ person["given-names"] }} {{ person["family-names"] }} {% endif %}<br>{% endfor %}  | {% if bep.status %} {% for item in bep.status %} - {{ item }} <br>{% endfor %} {% endif %}  | {% if bep.blocking %}  {% for item in bep.blocking %} - {{ item }} <br>{% endfor %} {% endif %} |
+| [BEP {{ bep.number }}](./beps/bep_{{ bep.number }}.md) | {% if bep.display %} {{ bep.display }} {% else %} {{ bep.title }} {% endif %} | {% for content in bep.content %} {{ content }} {% endfor %} | {% for person in bep.leads %} {% if person.email %} [{{ person["given-names"] }} {{ person["family-names"] }}](mailto:{{ person.email }}) {% else %} {{ person["given-names"] }} {{ person["family-names"] }} {% endif %}<br>{% endfor %} |
 {% endfor %}

tools/build/generate_bep_pages.py

@@ -0,0 +1,42 @@
+"""Generate a page for each BEP based on its metadata."""
+
+import ruamel.yaml
+from jinja2 import Environment, FileSystemLoader, select_autoescape
+from rich import print
+
+from bids_website.utils import root_dir
+
+yaml = ruamel.yaml.YAML()
+yaml.indent(mapping=2, sequence=4, offset=2)
+
+TEMPLATES_DIR = root_dir() / "templates"
+
+WEBSITE_DATA_DIR = root_dir() / "data"
+
+
+def return_jinja_env() -> Environment:
+    return Environment(
+        loader=FileSystemLoader(TEMPLATES_DIR),
+        autoescape=select_autoescape(),
+        lstrip_blocks=True,
+        trim_blocks=True,
+    )
+
+
+def generate_bep_page(bep: dict) -> str:
+    env = return_jinja_env()
+    template = env.get_template("bep_page_md.jinja")
+    content = template.render(bep=bep)
+    output_file = (
+        root_dir() / "docs" / "extensions" / "beps" / f"bep_{bep['number']}.md"
+    )
+    output_file.write_text(content)
+    print(f" generated: {output_file}")
+
+
+BEPS = yaml.load(WEBSITE_DATA_DIR / "beps" / "beps.yml")
+
+for bep in BEPS:
+    print(bep["number"])
+    assert "google_doc" in bep or "pull_request" in bep
+    generate_bep_page(bep)