Repository navigation
🔧 ubproject.toml: furo source triple for ubc build html view/edit buttons - #1764
Merged
Merged
Conversation
…t buttons ubc build html now renders furo-parity "view this page" / "edit this page" buttons from the same three values conf.py already passes to furo (html_theme_options: source_repository / source_branch / source_directory). Adding them to the ubCode config makes the ubc-built docs link to the same files the Sphinx/furo build's buttons do — the URLs were verified byte-identical against the live furo build during development. Released ubc versions that predate the keys ignore them; schema-aware editors may flag the three lines as unknown properties until the next ubCode release publishes the updated config schema.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1764 +/- ##
==========================================
+ Coverage 86.87% 89.61% +2.73%
==========================================
Files 56 73 +17
Lines 6532 10690 +4158
==========================================
+ Hits 5675 9580 +3905
- Misses 857 1110 +253
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
chrisjsewell
marked this pull request as ready for review
August 14, 2026 20:33
Merged
chrisjsewell
added a commit
that referenced
this pull request
Aug 27, 2026
## Release v8.4.0 Minor release. Headline changes: the `needflow` portable vocabulary (`:direction:`, named legends, `:show_link_names:` values), the new `needs_card_layouts` configuration, `list2need` rebuilt to create its needs directly, and `max_items` on every view. ### Changes - Bump version to `8.4.0` in `sphinx_needs/__init__.py` - Bump `NEEDS_VERSION` to `8.4.0` in the Docker workflow - Stamp the changelog's "Unreleased" section as `8.4.0` — release date `27.08.2026`, the `v8.3.1...v8.4.0` compare link, and a release summary - Move the `needtable :style_col:` deprecation out of "Improvements" into a "Deprecations" heading, matching 8.2.0 - Add the one missing entry: 📚 `list2need` documentation corrections (#1788) `docs/_static/tutorial_needs.json` is **not** regenerated this time — #1755 stopped tracking it, so unlike 8.2.0 and 8.3.0 there is nothing to commit for it. There are no `.. versionadded:: unreleased` markers to stamp either; every one in `docs/` was already written as `8.4.0`. ### Coverage All 24 commits since 8.3.1 were reviewed against the changelog. 19 user-facing changes all have entries; 5 are internal or convention-exempt (#1747, #1764 — `docs/ubproject.toml` only; #1763 — README only; #1781 — tests only; #1769 — refactor, filed under "Internal changes"). One gap was found and filled: #1788's `list2need` documentation corrections. ### Release steps after merge 1. Merge this PR 2. Create and push tag `8.4.0` — the release pipeline (`.github/workflows/release.yaml`) publishes to PyPI on tag push
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.
ubc build htmlnow renders furo-parity "view this page" / "edit this page" buttons in the content-icon row, driven by the same three valuesconf.pyalready passes to furo (html_theme_options:source_repository/source_branch/source_directory). This adds the triple todocs/ubproject.tomlso the ubc-built docs link to the same source files the Sphinx/furo build's buttons do.The values mirror
conf.pyexactly, and the resulting URLs were verified byte-identical against the live furo build of these docs (e.g.filter.rst→blob/master/docs/filter.rst?plain=true/edit/master/docs/filter.rst) during development of the feature (useblocks/ubcode#2916, useblocks/ubcode#2919).Two sequencing notes:
ubcversions that predate the keys simply ignore them — nothing breaks.