Skip to content

Pin zensical version#43

Merged
stuitje merged 3 commits into
mainfrom
ks/zensical
May 13, 2026
Merged

Pin zensical version#43
stuitje merged 3 commits into
mainfrom
ks/zensical

Conversation

@stuitje

@stuitje stuitje commented May 13, 2026

Copy link
Copy Markdown
Contributor

Pin Zensical version to the older version of 0.0.39 (newest release: 0.0.41) to hopefully fix the problem with the documentation build.

I also added a dark-mode version of the PROTEUS schematic (this schematic might be switched later; but for now this might be a nice addition).

@stuitje stuitje self-assigned this May 13, 2026
@stuitje stuitje requested a review from a team as a code owner May 13, 2026 10:39
@stuitje stuitje added bug Something isn't working documentation Improvements or additions to documentation labels May 13, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aims to stabilize the documentation build by pinning the zensical documentation tool to a known-working version, and improves docs presentation by switching the PROTEUS schematic to local light/dark-mode assets.

Changes:

  • Pin zensical to 0.0.39 in the docs optional dependency set to avoid regressions impacting the docs build.
  • Replace externally hosted PROTEUS schematic image links with locally versioned light/dark-mode images in documentation pages.
  • Add a dark-mode schematic variant (and reference both variants using #only-light / #only-dark fragments).

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.

File Description
pyproject.toml Pins zensical in the docs extra to stabilize docs builds.
docs/proteus_framework.md Updates schematic embedding to use local light/dark assets.
docs/Explanations/proteus.md Updates schematic embedding to use local light/dark assets with correct relative paths.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nichollsh nichollsh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs build successfully on my laptop with zensical==0.0.39 and python==3.12.12. Dark/light switch mode schematic works and looks great.

@stuitje stuitje merged commit f20b0cd into main May 13, 2026
10 checks passed
@stuitje stuitje deleted the ks/zensical branch May 29, 2026 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants