Migrate docs to Zensical#434
Draft
leonlan wants to merge 9 commits into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
- Move build_examples.py to scripts/ and anchor paths to repo root - Drop dead .doc-* CSS overrides, keep the API overview card grid - Remove redundant matplotlib and unused ruff docs deps; dedupe jupyter via include-group - Restore full Gantt chart figure alt text
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
1 participant
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.
Summary
Impact
This keeps the executed-notebook guarantee from the old nbsphinx setup while moving static rendering and API generation to the Zensical/MkDocs ecosystem.
Validation
cd docs && uv run make clean && uv run make htmlcd docs && uv run zensical build --strict --cleanuv run ruff check docs/build_examples.py pyjobshop/ProblemData.py pyjobshop/Solution.pyuv run pytest tests/ -q -k "objective or ProblemData" --solvers ortools(163 passed, 1 skipped, 67 deselected)Note: the same pytest selector without
--solvers ortoolsfails locally because CP Optimizer/docplex is not installed.