Skip to content

Autodoc: guide markdown files are dependencies #15865

Closed
@kristoff-it

Description

@kristoff-it

Related to #15864, today we define which guides should be included in a build of Autodoc by mentioning them in the root file container-level doc comment, like so:

//!zig-autodoc-guide: intro.md
//!zig-autodoc-guide: quickstart.md
//!zig-autodoc-guide: advanced-docs/advanced-stuff.md

//!zig-autodoc-section: CLI Usage

//!zig-autodoc-guide: cli-basics.md
//!zig-autodoc-guide: cli-advanced.md

As things stand currently, those files are not recognized as input files by the caching system, meaning that changing them will not trigger a rebuild in the case of a cache hit for everything else. Today this is in practice mostly fine since Autodoc doesn't really integrate with the cache system at all, but once #15864 is fixed, this will become a more prominent issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    autodocThe web application for interactive documentation and generation of its assets.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions