Move zensical.toml to docs/, convert write scripts to markdown, update nav#261
Move zensical.toml to docs/, convert write scripts to markdown, update nav#261joamatab wants to merge 8 commits into
Conversation
Reviewer's GuideUpdates documentation generation to use Markdown and MkDocs-style configuration, moves zensical config into docs/, and wires new cell/model reference pages into both HTML and PDF builds. Flow diagram for updated docs build pipeline using Markdown and docs/zensical.tomlflowchart LR
dev[Developer] --> make_docs[make docs]
make_docs --> write_cells[write_cells_* scripts]
write_cells --> md_files[Generate *.md reference files]
make_docs --> changelog[Copy CHANGELOG.md to docs/changelog.md]
make_docs --> zensical_build[zensical build -f docs/zensical.toml]
zensical_build --> nav["Use docs/zensical.toml nav (includes cells_* pages)"]
zensical_build --> html_site[Build HTML site to _build/html]
dev --> make_docs_serve[make docs-serve]
make_docs_serve --> zensical_serve[zensical serve -f docs/zensical.toml]
zensical_serve --> local_preview[Serve docs on localhost:8080]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Code Review
This pull request migrates the documentation generation scripts from reStructuredText (.rst) to Markdown (.md) and updates the documentation configuration files (zensical.toml and mkdocs-pdf.yml) to include the new cell documentation pages. Additionally, the Makefile was updated to point to the correct configuration file. The review identified several copy-paste errors in the .github/write_cells_sin300.py script where the module paths were incorrectly referencing si220_cband instead of sin300, which need to be corrected to ensure proper documentation generation.
|
|
||
|
|
||
| .. autofunction:: cspdk.si220.cband.cells.{name} | ||
| ::: cspdk.si220.cband.cells.{name} |
There was a problem hiding this comment.
| :include-source: | ||
|
|
||
| import cspdk | ||
| ::: cspdk.si220.cband.cells.{name} |
| ```python | ||
| import cspdk | ||
|
|
||
| c = cspdk.si220.cband.cells.{name}({kwargs}).copy() |
- Handle colon-fence MyST directives - Strip UPPERCASE braces that mkdocstrings resolves - Output notebook markdown to docs root (zensical skips subdirs)
The sin300 write script was generating mkdocstrings directives pointing to cspdk.si220.cband.cells instead of cspdk.sin300.cells (copy-paste error). This caused the docs build to fail with "Could not collect 'cspdk.si220.cband.cells.array'" since array exists in sin300 but not in si220.cband.
Summary
zensical.tomlintodocs/directorywrite_cells/write_modelsscripts to output Markdown instead of RSTzensical build -f docs/zensical.tomlTest plan
make docsbuilds successfullySummary by Sourcery
Move documentation generation from reStructuredText to Markdown and update docs configuration and navigation accordingly.
New Features:
Enhancements: