Repository navigation
chore: update to python-template v1.2.1 - #3
Merged
Merged
Conversation
Takes pystiltctl from python-template v1.1.3 to v1.2.1. v1.2.0 runs examples when the docs build: a `.. plot::` figure in a docstring's Examples section, and `.. ipython:: python` blocks in .rst pages that show each line with its output. A block or figure that raises, or that emits a Python warning, fails the build. Notebooks and Markdown code cells (myst-nb, with Jupyter) are a template question, `docs_notebooks`, answered no here. v1.2.1 raises the docs floors to pydata-sphinx-theme 0.22 and Sphinx 8.2, which the theme requires. - docs/conf.py loads the plot and IPython directives and saves the IPython figures under docs/_build. - ipython and matplotlib join the dev group. uv.lock gains 23 packages (IPython and its dependencies) and no package version moves. - AGENTS.md gains the template's section on writing examples. pystiltctl has nothing to plot yet, so no page uses it. - The live preview ignores docs/_build and __pycache__, so a build's own output does not trigger the next build. - CONTRIBUTING.md and the justfile say that `just build-docs` runs the examples. The ruff pre-commit hooks check notebooks, as `just lint` does.
Codecov Report✅ All modified and coverable lines are covered by tests. |
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
2 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.
Takes pystiltctl from python-template v1.1.3 to v1.2.1.
v1.2.0 runs examples when the docs build: a
.. plot::figure in a docstring's Examples section, and.. ipython:: pythonblocks in.rstpages that show each line with its output (jmineau/python-template#17). A block or figure that raises, or that emits a Python warning, fails the build. Notebooks and Markdown code cells (myst-nb, which brings Jupyter) are a template question,docs_notebooks, answered no here. v1.2.1 raises the docs floors to pydata-sphinx-theme 0.22 and Sphinx 8.2 (jmineau/python-template#18).pystiltctl has nothing to plot yet, so no page uses the new directives.
docs/conf.pyloads them,ipythonandmatplotlibjoin thedevgroup, anduv.lockgains 23 packages (IPython and its dependencies) without moving any package version. The live preview ignoresdocs/_buildand__pycache__. AGENTS.md has the template's section on writing examples, and CONTRIBUTING.md and the justfile say thatjust build-docsruns the examples.just quality-check(2 tests) and a cleanjust build-docspass, as do all the pre-commit hooks.