Skip to content

build: ignore docs/_build, the retired mystmd output - #561

Open
ljchang wants to merge 1 commit into
masterfrom
build/ignore-docs-build
Open

ljchang wants to merge 1 commit into
masterfrom
build/ignore-docs-build

Conversation

@ljchang

@ljchang ljchang commented Oct 8, 2026

Copy link
Copy Markdown
Member

Problem

docs/_build/ holds output from the old mystmd toolchain and wasn't gitignored. A broad git add -A on #560 committed 3,039 files from it (about 450k lines). Zensical builds every file under docs/, and those stale pages use MyST directives such as :::{grid} 1 2 2 2 and :::{tip} Interactive version. mkdocstrings reads ::: as a request to load a Python object, so the strict docs build failed with PluginError: Could not collect ':{grid} 1 2 2 2'.

Change

Add docs/_build/ to .gitignore, with a comment explaining why.

Zensical has no setting to exclude pages, so a stale local docs/_build/ would still break a local docs-build. The ignore rule only stops it from being committed again.

#560 has already been cleaned: its branch was rebuilt with only its 3 source files.

Zensical builds every file under docs/, and stale mystmd pages carry MyST
directives (:::{grid}) that the strict build cannot parse. A broad git add
committed 3,039 of them to #560 and failed its docs build; ignoring the
directory keeps that from recurring.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant