Skip to content

docs: Align Starlight site with generated hierarchy graphs #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
DanielKellerM wants to merge 1 commit into
base: devel
Choose a base branch
from
Draft

docs: Align Starlight site with generated hierarchy graphs #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/site/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Generated hierarchy graphs (copied in by `make idma_doc_site`)
public/fig/graph/
27 changes: 27 additions & 0 deletions doc/site/src/content/docs/architecture/hierarchy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Module Hierarchy
description: Generated module-hierarchy graphs for the synthesizable iDMA tops.
---

These graphs are generated from the bender-pickle syntax tree (`util/ast2dot.py`)
for each synthesizable top, so they always reflect the current RTL. Regenerate
them with `make idma_doc_all`, then `make idma_doc_site` copies them into this
site under `public/fig/graph/`.

:::note[Draft]
This page is a starting point for aligning the site with the regenerated
hierarchy graphs — the figures and prose are still being brought up to date with
the latest repository state.
:::

## Backend — `rw_axi`

![idma_backend_synth_rw_axi](/fig/graph/idma_backend_synth_rw_axi.png)

## ND Midend

![idma_nd_midend_synth](/fig/graph/idma_nd_midend_synth.png)

## Descriptor Frontend

![idma_desc64_synth](/fig/graph/idma_desc64_synth.png)
8 changes: 8 additions & 0 deletions idma.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,14 @@ idma_spinx_doc: $(IDMA_RTL_DOC_ALL)
idma_spinx_doc_clean:
rm -rf $(IDMA_DOC_OUT_DIR)

.PHONY: idma_doc_site

IDMA_SITE_DIR := $(IDMA_ROOT)/doc/site

idma_doc_site: $(IDMA_RTL_DOC_ALL)
mkdir -p $(IDMA_SITE_DIR)/public/fig/graph
cp -f $(IDMA_DOC_FIG_DIR)/graph/*.png $(IDMA_SITE_DIR)/public/fig/graph/


# --------------
# Nonfree
Expand Down
Loading