docs(v1): move arithmetic-convention specs into doc/ as published rst#861
Merged
Merged
Conversation
Relocates the load-bearing v1 specs out of the untracked-by-Sphinx arithmetics-design/ folder into the rendered docs site: - Convert convention.md / goals.md / legacy-removal.md → reStructuredText under doc/design/ and wire them into a "Design & Internals" toctree in doc/index.rst. rst (not markdown) so no myst-parser dependency is needed. - Update every path reference: linopy/semantics.py and the five `LEGACY: remove at 1.0` comments in linopy/expressions.py, the test_legacy_violations.py header, and the arithmetics-design/ scaffolding files (open-items.md, docs-plan.md) that link to them. - release_notes.rst and migrating-to-v1.rst now cross-reference the rendered convention page via :doc: instead of a GitHub blob URL. The three process/scaffolding files (docs-plan.md, open-items.md, multiindex-feasibility.md) stay in arithmetics-design/ as internal notes. Docs build clean (sphinx-build exit 0, all three pages render, no new warnings); ruff + the convention test suite pass. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
FabianHofmann
approved these changes
Jul 21, 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.
Stacked on #717 — relocating the v1 arithmetic-convention specs into the published docs.
Note
Generated by AI (Claude Opus 4.8) per the placement decision: move the spec files into doc/, keep the scaffolding internal.
What & why. The load-bearing specs (
convention.md,goals.md,legacy-removal.md) lived inarithmetics-design/, which Sphinx never rendered. This moves them into the docs site so they're discoverable, and keeps the code's§N/ path references pointing somewhere real.doc/design/(rst, not markdown, so nomyst-parserdependency) and wired into a new "Design & Internals" toctree indoc/index.rst.linopy/semantics.py, the five# LEGACY: remove at 1.0 — see …comments inlinopy/expressions.py, thetest_legacy_violations.pyheader, and the scaffolding files (open-items.md,docs-plan.md) that link to them.release_notes.rst/migrating-to-v1.rstnow use an internal:doc:cross-reference to the rendered convention page instead of ablob/master/...URL.docs-plan.md,open-items.md,multiindex-feasibility.md) stay inarithmetics-design/as internal notes, per the agreed scope.Note:
convention.md§11's MultiIndex snippet was already fixed by #856, so no content change was needed there — this PR is purely relocation + reference updates.Verification:
sphinx-buildexits 0, all three pages render, no new warnings (count 891→890, just a title-underline fix);ruffclean; the convention test suite passes.How the build was validated
The repo's docs extra pins
numpy<2whilebenchmarkspins2.4.6, so a fulluv synccan't resolve — validated in an isolated.[docs]env instead. Built with-D nbsphinx_execute=never(notebooks need solvers) to check toctree +:doc:resolution + rst syntax without executing notebooks.