(sigil docs commands)
(sigil docs commands) - Documentation validation and API generation
Provides commands for checking documentation code blocks and generating API documentation from source files.
For building and serving documentation sites, use sigil publish.
Exports
docs-handlerprocedureMain handler for sigil docs command
docs-check-handlerprocedureCheck documentation code blocks
docs-api-handlerprocedureGenerate API documentation
workspace-path->nameprocedureExtract package name from a workspace package path "packages/sigil-stdlib" => "sigil-stdlib"
get-workspace-package-orderprocedureGet package order from workspace, if available Returns #f if no workspace found, or list of package names in order
find-packagesprocedureFind all packages, respecting workspace order when available
extract-all-package-docsprocedureExtract docs from all packages
extract-package-docsprocedureExtract docs from a single package
find-sgl-filesprocedureFind all .sgl files recursively
check-all-coverageprocedureCheck coverage for all packages
print-coverage-reportprocedurePrint coverage report
module-name->slugprocedureGenerate API pages for all packages
generate-package-index-htmlprocedureGenerate package index page
url-encode-fragmentprocedureURL-encode a string for fragment identifiers
generate-module-htmlprocedureGenerate HTML for a module
generate-symbol-indexprocedureGenerate symbol index and landing page
extract-summaryprocedureExtract summary from description
description->sxmlprocedureParse description as markdown
generate-api-landing-pageprocedureGenerate landing page
generate-symbols-pageprocedureGenerate symbols page
collect-pkg-symbolsprocedureCollect symbols from packages
scan-markdown-filesprocedureScan directory for markdown files
check-all-filesprocedureCheck all files for code blocks
check-fileprocedureCheck a single file
extract-code-blocksprocedureExtract code blocks from SXML
file-session-nameprocedureGenerate session name from file path
execute-and-report-blocksprocedureExecute blocks and report
repl-style-block?procedureCheck for REPL style
execute-code-blockprocedureExecute a code block
execute-repl-blockprocedureExecute REPL-style block
parse-repl-entriesprocedureParse REPL entries
parens-balanced?procedureCheck balanced parens
execute-repl-entryprocedureExecute single REPL entry
format-result-for-comparisonprocedureFormat result for comparison
results-match?procedureCheck results match
flonum-string-match?procedureCheck float match
truncate-codeprocedureTruncate code for display
show-docs-helpprocedureShow help