docs: enable myst_parser so Markdown docs actually publish#40
Merged
Conversation
The docs toctree (index.rst) references several Markdown documents — dsl_tutorial, dsl_reference, material_schema_spec, mesh_validation, etc. — but conf.py only registered source_suffix='.rst' and never loaded a Markdown parser. As a result Sphinx emitted 'toctree contains reference to nonexisting document' for every .md file and those pages did NOT render on the published (Read the Docs) site. Verified by A/B build: - WITHOUT this change: dsl_guide/dsl_tutorial/dsl_reference all fail with 'nonexisting document'; no HTML produced. - WITH this change: all three render to HTML; build succeeds. Fix (minimal, standard): - conf.py: append 'myst_parser' to extensions (guarded by a try/import so an RST-only build still works if MyST isn't installed) and set source_suffix to map .rst→restructuredtext, .md→markdown. - docs/requirements.txt: add myst-parser so Read the Docs installs it. This is a pure infrastructure fix — no doc content changes here (the new DSL Language Guide + toctree wiring land in a separate commit). Co-authored-by: jarvis-rich
dml-jarvis
pushed a commit
that referenced
this pull request
Jun 3, 2026
The yapCAD DSL had a reference (function/type catalog) and a tutorial (one worked example), but no document teaching the language AS a language — its mental model, execution semantics, and idioms. Newcomers had no on-ramp and no 'how to think in this DSL' guide; the why/how lived scattered across index.rst prose and historical specs. Adds docs/dsl_guide.md — a DSL Language Guide covering: - what the DSL is and why it exists (type safety, guaranteed termination, provenance, automation/LLM-friendliness) - the execution model (module -> command -> emit -> CLI) - UPPERCASE-export vs lowercase-helper command convention - thinking in static types; the angle-units convention (degrees for geometry/transforms, radians for trig); control flow and no-while design - the build/transform/boolean composition workflow - idioms & gotchas (over-cut subtractions, 0.0 - x negation, degrees/radians mismatch, require contracts, aggregation over chained unions, radial patterns) - @meta/@ui annotations and the CLI lifecycle Documents the degrees-vs-radians convention that was previously only implicit in per-function comments: transform/geometry functions (rotate, rotate_2d, arc, ellipse) take DEGREES; trig (sin/cos/tan) takes RADIANS. Added prominent callouts to the Guide (§4 + gotchas), the Reference (Transformation + Math section headers), and the Tutorial (Tips). Also wires the three docs into a clear learning path: - index.rst toctree reordered to Guide -> Tutorial -> Reference - reciprocal cross-links added to the Tutorial and Reference headers/footers Depends on the myst_parser fix (PR #40, merged) for the Markdown to render. Docs build verified clean (no dsl_guide warnings) against main. Co-authored-by: jarvis-rich
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs toctree (index.rst) references several Markdown documents — dsl_tutorial, dsl_reference, material_schema_spec, mesh_validation, etc. — but conf.py only registered source_suffix='.rst' and never loaded a Markdown parser. As a result Sphinx emitted 'toctree contains reference to nonexisting document' for every .md file and those pages did NOT render on the published (Read the Docs) site.
Verified by A/B build:
Fix (minimal, standard):
This is a pure infrastructure fix — no doc content changes here (the new DSL Language Guide + toctree wiring land in a separate commit).
Co-authored-by: jarvis-rich