Skip to content

Commit c12459c

Browse files
committed
docs(CHANGES) sphinx-gp-opengraph and sphinx-gp-sitemap, with brief subsections
why: after the filter-repo sweep collapsed the gp-* → sphinx-gp-* rename across the entire branch history, the Features section had three multi-paragraph bullets describing the new packages plus the gp-sphinx auto-wiring. Replace them with three brief #### subsections that describe the shipped surface in two sentences each, name the renamed packages, and carry the (#22) PR ref. what: - CHANGES: replace the three SEO Features bullets with three #### subsections — "New package: sphinx-gp-opengraph", "New package: sphinx-gp-sitemap", and "gp-sphinx: SEO config auto-wired from docs_url" — each ~3 lines, with (#22) PR refs - uv.lock: refresh certifi (incidental)
1 parent 158bf53 commit c12459c

2 files changed

Lines changed: 57 additions & 57 deletions

File tree

CHANGES

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,25 @@ $ uv add gp-sphinx --prerelease allow
3131

3232
### Features
3333

34-
- `sphinx-gp-opengraph`: new workspace package providing OpenGraph and Twitter
35-
meta-tag emission for Sphinx. Drop-in replacement for the
36-
transitive `sphinxext-opengraph` dep — same `ogp_*` configuration
37-
surface, minus the matplotlib-based social-card generator (which is
38-
accepted but ignored, with a one-line warning pointing at the
39-
static-image workflow). Replaces `sphinxext.opengraph` in
40-
`DEFAULT_EXTENSIONS`.
41-
- `sphinx-gp-sitemap`: new workspace package providing `sitemap.xml`
42-
generation for Sphinx. Added to `DEFAULT_EXTENSIONS` so every
43-
gp-sphinx site gets a sitemap out of the box. Drop-in replacement
44-
for the standalone `sphinx-sitemap` package with three Sphinx 8.1+
45-
modernizations: plain `env.temp_data` list instead of
46-
`multiprocessing.Queue`, `app.builder.name == "dirhtml"` instead of
47-
an `env.is_directory_builder` monkey-patch, and
48-
`contextlib.suppress(ExtensionError)` instead of a bare
49-
`except BaseException`.
50-
- `gp-sphinx`: `merge_sphinx_config` auto-wires `site_url` (for
51-
`sphinx-gp-sitemap`) from `docs_url`, alongside the existing
52-
`ogp_site_url` / `ogp_site_name` / `ogp_image` auto-wiring.
34+
#### New package: `sphinx-gp-opengraph`
35+
36+
OpenGraph meta-tag emission. Drop-in for `sphinxext-opengraph`,
37+
matplotlib-free; `ogp_social_cards` is accepted but ignored with a
38+
warning. Replaces `sphinxext.opengraph` in `DEFAULT_EXTENSIONS`.
39+
(#22)
40+
41+
#### New package: `sphinx-gp-sitemap`
42+
43+
`sitemap.xml` generator. Drop-in for `sphinx-sitemap` with Sphinx
44+
8.1+ idioms — no `multiprocessing.Queue`, public `dirhtml` detection,
45+
narrow `ExtensionError` handling. Added to `DEFAULT_EXTENSIONS`.
46+
(#22)
47+
48+
#### `gp-sphinx`: SEO config auto-wired from `docs_url`
49+
50+
`merge_sphinx_config` auto-derives `ogp_site_url`, `ogp_site_name`,
51+
`ogp_image`, `site_url`, and `sitemap_url_scheme` (flat `"{link}"`)
52+
from a single `docs_url`. (#22)
5353
- `sphinx-gp-theme`: dispatch `gp-sphinx:navigated` CustomEvent on
5454
`document` after every SPA-nav DOM swap. Third-party widgets that bind to
5555
swapped DOM can listen for this event to re-initialise after navigation

uv.lock

Lines changed: 38 additions & 38 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)