Skip to content

Add Markdown register documentation - #258

Merged
olagrottvik merged 1 commit into
masterfrom
markdown-docs
Oct 27, 2026
Merged

olagrottvik merged 1 commit into
masterfrom
markdown-docs

Conversation

@olagrottvik

@olagrottvik olagrottvik commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #96.

  • Every run writes doc/<module>.md (a register list linking to a bits table per register) next to the .tex and .html. -d skips it.
  • New markdown_cell filter escapes Markdown in descriptions and keeps code spans.
  • Docs: "Headers and documentation" is split into Documentation (HTML, PDF and Markdown, each with the prototype example) and Software headers.

@olagrottvik olagrottvik added this to the 1.1.0: cloud-ready core milestone Oct 27, 2026 — with Claude
@olagrottvik olagrottvik self-assigned this Oct 27, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 bust | 🛠️ Build #35452430 | 📁 Comparing 70f5965 against latest (9ac90f3)

  🔍 Preview build  

11 files changed · + 3 added · ± 7 modified · - 1 deleted

+ Added

± Modified

- Deleted

@olagrottvik
olagrottvik merged commit 128fc74 into master Oct 27, 2026
11 checks passed
@olagrottvik
olagrottvik deleted the markdown-docs branch October 27, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation generation: Markdown

1 participant