Convert sphinx to zensical - #611
Open
popescu-v wants to merge 14 commits into
Open
Conversation
…ical - don't release the Python API docs anymore: they are build in khiops-doc; - have create-doc only prepare the build environment when asked; this allows code sharing with khiops-doc which only needs the preparation part; - add minor path updates for the move from Sphinx to MkDocs; - correctly extract Pip package version from RFC-822 metadata; - inject samples version in the integration test jobs' environment; without this change, the default branch of the khiops-samples repository was being used on non-workflow dispatch events; - drop spurious "toml" build-time dependency for Python >= 3.12; since Python 3.11, TOML parsing features are supported via the standard-library `tomllib` module; - build docs in strict mode to fail on broken links; - log tutorial conversion execution errors but continue the conversion; - attempt to silence IPKernel warnings on tutorial conversion; - drop versioning hook, unsupported by Zensical; inject the version through the create-doc build script instead; - copy samples Python and Notebook code to the doc/ dir for file locality; Zensical fails to include the samples otherwise, because they are outside the doc/ build dir; - inject current Khiops Python version into the site build; - build site outside the doc dir, as per Zensical hard constraint; contrary to Sphinx, Zensical does not support having the site built inside the doc dir; - exclude doc/README.md from the build; - update doc READMEs and relevant Copilot instructions.
Zensical does not support file exclusion lists or wildcards. Hence, the separation needs to be done upfront.
popescu-v
force-pushed
the
convert-sphinx-to-zensical
branch
5 times, most recently
from
August 18, 2026 12:05
851f07d to
ff150f0
Compare
Use active Uv virtual environment in doc/utils/create-doc to allow its invocation from "enclosing" khiops-doc environments. Run the api-docs workflow directly on the GitHub runner; the specific Docker image is no longer needed.
popescu-v
force-pushed
the
convert-sphinx-to-zensical
branch
from
August 18, 2026 12:17
ff150f0 to
947bf80
Compare
popescu-v
force-pushed
the
convert-sphinx-to-zensical
branch
from
August 18, 2026 12:55
947bf80 to
3e3b40b
Compare
popescu-v
marked this pull request as ready for review
August 18, 2026 12:56
tramora
reviewed
Aug 18, 2026
| Returns | ||
| ------- | ||
| `.Dictionary`: | ||
| [`Dictionary`][]: |
Collaborator
There was a problem hiding this comment.
A bit surprised by the new syntax of link-like reference without any link in the second group of brackets
tramora
reviewed
Aug 18, 2026
tramora
reviewed
Aug 18, 2026
tramora
approved these changes
Aug 18, 2026
tramora
left a comment
tramora
left a comment
Collaborator
There was a problem hiding this comment.
No blocking remarks so far. I just put minor comments that can be ignored.
It no longer points to a PDF file, but to a Markdown-based page.
Otherwise, it gets promoted to the upper "API Reference" nav item.
popescu-v
force-pushed
the
convert-sphinx-to-zensical
branch
from
August 27, 2026 14:50
9ce3cb2 to
812e44a
Compare
tramora
reviewed
Aug 27, 2026
| # supported by khiops, but this should pose no issue in practice) | ||
| # TODO: Revert as soon as issue | ||
| # https://github.com/KhiopsML/khiops-python/issues/602 is tackled | ||
| uv run kh-status || true |
Collaborator
There was a problem hiding this comment.
The TODO is legit but with the installation under uv we don't get an Error but a Warning instead.
In this case kh-status still returns a 0 code.
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
3 participants
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.
Put your message here
TODO Before Asking for a Review
main(ormain-v10)Unreleasedsection ofCHANGELOG.md(no date)index.html