livery.extensions.docs._steps¶
livery.extensions.docs._steps ¶
The docs extension's steps: generators run, and links resolve.
docs.generators, a step of the docs phase, runs the verbs each
package names under [docs] generators before the site builds.
lint.doclinks reads the authored markdown of the workspace's docs/
and of every member's docs/, and refuses a link to a file that does
not exist or an anchor no heading of the target makes.
The strict site build judges what they leave out: the links into the pages generated at build time, the pages a package's own generators write, and the nav.
Functions:
| Name | Description |
|---|---|
link_problems |
Every unresolvable link or anchor in the authored docs under root. |
headings_removed |
Whether a changed markdown file lost a heading, an anchor a link may name. |
run_generators |
Run every package's declared docs generators; the verbs run. |
generators_run |
Run the verbs the packages name under |
doclinks_run |
|
Attributes:
| Name | Type | Description |
|---|---|---|
SITE_TREES |
|
SITE_TREES
module-attribute
¶
link_problems ¶
Every unresolvable link or anchor in the authored docs under root.
A link into packages/<name>/, where the site mounts each member's
docs, maps back to that package's docs/; a generated target and a
package's changelog page are written at build time, and the strict
build judges them. pages keeps the judgment to those
root-relative pages; every link still resolves against the whole
tree.
Source code in packages/extensions/docs/src/livery/extensions/docs/_steps.py
headings_removed ¶
Whether a changed markdown file lost a heading, an anchor a link may name.
A link in an unchanged page may point at it, so lint.doclinks
then judges every page.
Source code in packages/extensions/docs/src/livery/extensions/docs/_steps.py
run_generators ¶
Run every package's declared docs generators; the verbs run.
Each verb runs as its own runner invocation at the workspace root, in the packages' order and each verb once, so a generator is the task a person would type. A failing generator turns the build red with the verb and its package named; its own output has already streamed. Generators must be idempotent: a second run on unchanged input is a no-op.
Source code in packages/extensions/docs/src/livery/extensions/docs/_steps.py
generators_run ¶
generators_run(ctx: PhaseContext) -> None
Run the verbs the packages name under [docs] generators: a docs step.
run_generators over the workspace, the verbs it ran said.
Source code in packages/extensions/docs/src/livery/extensions/docs/_steps.py
doclinks_run ¶
doclinks_run(ctx: PhaseContext) -> None