aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornatsuoto <[email protected]>2026-04-28 16:42:28 +0530
committerBobby <[email protected]>2026-04-28 17:04:42 +0530
commitf55b6d06b114a1e1a652ffd5203e31d1b9f41862 (patch)
tree3b54135d9036af662a74b6ebe549090d63afb048 /docs
parent013c786d5c460e572ef4187e1aac8bf7782ec8f2 (diff)
downloadedify-f55b6d06b114a1e1a652ffd5203e31d1b9f41862.tar.xz
edify-f55b6d06b114a1e1a652ffd5203e31d1b9f41862.zip
chore(release): bump version to 0.3.0 and write changelog
Park the metadata at 0.3.0. This is not the release — the changelog header stays "(unreleased)" and we'll swap in a date when we actually tag. - setup.py, docs/conf.py, src/edify/__init__.py, .bumpversion.cfg: 0.2.2 -> 0.3.0. - README.rst: bump both `commits-since/v0.2.2` shields to v0.3.0. The shield will 404 until v0.3.0 is tagged, which is an accepted trade-off for keeping `bumpversion` config consistent. - CHANGELOG.rst: replace Copilot's stub `Unreleased` heading with a real `0.3.0 (unreleased)` entry covering everything since 0.2.2 — Python 3.7 drop (#32), 3.12/3.13/3.14 support and RTD updates (#31), GitHub Actions and PyPy and pre-commit modernization (#33, #35, #37), dependency floor bumps (#25-#29), repo infrastructure (#39), and housekeeping (#41, #43). - docs/conf.py: fix `extlinks` caption format. The old style — a bare prefix string like 'PR #' — was deprecated in Sphinx 5 and removed in Sphinx 6, but the bug stayed latent because no existing CHANGELOG entry actually used the `:pr:` or `:issue:` roles. The new changelog uses `:pr:` for every cross-reference, which is what surfaced the breakage in the docs CI job. Updated both captions to the modern `'PR #%s'` / `'#%s'` form. Closes #44
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py13
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py
index bf7d99a..eb29037 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -20,14 +20,21 @@ project = 'Edify'
year = '2022-2026'
author = 'Bobby'
copyright = '{0}, {1}'.format(year, author)
-version = release = '0.2.2'
+version = release = '0.3.0'
pygments_style = 'trac'
templates_path = ['.']
extlinks = {
- 'issue': ('https://github.com/luciferreeves/edify/issues/%s', '#'),
- 'pr': ('https://github.com/luciferreeves/edify/pull/%s', 'PR #'),
+ 'issue': ('https://github.com/luciferreeves/edify/issues/%s', '#%s'),
+ 'pr': ('https://github.com/luciferreeves/edify/pull/%s', 'PR #%s'),
}
+# The "commits since latest release" shield in README.rst targets a
+# `compare/vX.Y.Z...main` URL, which 404s during the window between
+# bumping the version and tagging the release. Skip it in linkcheck
+# rather than letting docs CI fail every time we bump.
+linkcheck_ignore = [
+ r'https://github\.com/luciferreeves/edify/compare/v\d+\.\d+\.\d+\.\.\.main',
+]
# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'