Skip to content

HTML docs on every run, PDF only when pdflatex is present - #259

Merged
olagrottvik merged 8 commits into
masterfrom
html-docs-optional-pdf
Oct 27, 2026
Merged

olagrottvik merged 8 commits into
masterfrom
html-docs-optional-pdf

Conversation

@olagrottvik

@olagrottvik olagrottvik commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Part of #248. Markdown output is #258.

  • Write doc/<module>.html on every run: same layout as the PDF, inline SVG bit diagrams, links between the register list and the registers, a sidebar and print styles. Also returned by generate_files.
  • Build the PDF only when pdflatex is on PATH. Otherwise log one line and continue.
  • Show the prototype example as HTML and PDF on the Headers and documentation page. The docs build copies the HTML golden and builds the PDF from the .tex. Read the Docs installs TeX Live for it.
  • Tests: HTML goldens for all examples, and a run without pdflatex.

Conflicts with #258 in generation.py and the docs. Whichever merges second rebases and moves these examples to its example-output.md page.

@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 #35452281 | 📁 Comparing 79ff100 against latest (9ac90f3)

  🔍 Preview build  

6 files changed · + 1 added · ± 5 modified

+ Added

± Modified

@olagrottvik olagrottvik added this to the 1.1.0: cloud-ready core milestone Oct 27, 2026 — with Claude
@olagrottvik
olagrottvik force-pushed the html-docs-optional-pdf branch from 741934c to 1b0369f Compare October 27, 2026 13:45
@olagrottvik
olagrottvik merged commit 768ff6d into master Oct 27, 2026
11 checks passed
@olagrottvik
olagrottvik deleted the html-docs-optional-pdf branch October 27, 2026 19:38
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.

1 participant