fix: resolve readthedocs build failure and finalize zensical migration#61
Merged
JacksonFergusonDev merged 1 commit intomainfrom Apr 16, 2026
Merged
fix: resolve readthedocs build failure and finalize zensical migration#61JacksonFergusonDev merged 1 commit intomainfrom
JacksonFergusonDev merged 1 commit intomainfrom
Conversation
JacksonFergusonDev
added a commit
that referenced
this pull request
Apr 16, 2026
Update .readthedocs.yaml to use uv export and uv pip install --system. This ensures that the Zensical framework and documentation dependencies are installed into the active system environment utilized by the ReadTheDocs runner, rather than being isolated within a local .venv.
JacksonFergusonDev
added a commit
that referenced
this pull request
Apr 16, 2026
Update .readthedocs.yaml to use uv export and uv pip install --system. This ensures that the Zensical framework and documentation dependencies are installed into the active system environment utilized by the ReadTheDocs runner, rather than being isolated within a local .venv. Additionally, update mkdocs.yml to switch the emoji extension namespace from material to zensical, resolving the ModuleNotFoundError encountered during the build phase.
JacksonFergusonDev
added a commit
that referenced
this pull request
Apr 16, 2026
Update .readthedocs.yaml to use uv export and uv pip install --system. This ensures that the Zensical framework and documentation dependencies are installed into the active system environment utilized by the ReadTheDocs runner, rather than being isolated within a local .venv. Additionally, update mkdocs.yml to switch the emoji extension namespace from material to zensical, resolving the ModuleNotFoundError encountered during the build phase.
JacksonFergusonDev
added a commit
that referenced
this pull request
Apr 16, 2026
Update .readthedocs.yaml to use uv export and uv pip install --system. This ensures that the Zensical framework and documentation dependencies are installed into the active system environment utilized by the ReadTheDocs runner, rather than being isolated within a local .venv. Additionally, update mkdocs.yml to switch the emoji extension namespace from material to zensical, resolving the ModuleNotFoundError encountered during the build phase.
JacksonFergusonDev
added a commit
that referenced
this pull request
Apr 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR resolves the Read the Docs (RTD) build failure following the migration from
mkdocs-materialtozensical.The primary failure point was RTD's default execution logic; the presence of a
mkdocs:configuration block in.readthedocs.yamltriggered the built-in MkDocs pipeline. This environment attempts to runpython -m mkdocs build, which is incompatible with a project transitioned to the Zensical stack. The resolution involves implementing a decoupled, custom build flow. We now leverageuvfor deterministic dependency management, executezensical builddirectly, and explicitly route the generated static HTML artifacts to the designated RTD output directory.Changes
.readthedocs.yamlmkdocs:block: Removed the native section to prevent RTD from invoking its automated, legacy MkDocs build sequence.uvto provision the environment and install the requireddocsdependency group.zensical buildand maps the output to$READTHEDOCS_OUTPUT/html/, ensuring RTD can correctly ingest and serve the documentation.mkdocs.ymlzensical.extensions.emoji.*. This aligns the project with the Zensical compatibility layer, replacing the previous Material module paths.mkdocs.ymlschema rather than migrating tozensical.toml. This utilizes Zensical’s native support for legacy MkDocs configurations, minimizing friction during the transition.Why this works
While Zensical functions as a drop-in replacement for the MkDocs and Material ecosystem, it requires direct execution control. RTD’s internal logic defaults to the standard MkDocs binary if it detects the relevant YAML keys. By shifting to a command-based pipeline, we bypass the restrictive default environment and allow Zensical to parse the existing
mkdocs.ymlmetadata and generate the site independently.Verification
zensical buildcompiles the documentation successfully against the current configuration without schema errors.$READTHEDOCS_OUTPUT/html/path.