Skip to content

Commit b2e42f8

Browse files
authored
docs: Add stable anchors to changelog (#2784)
Switch from the deprecated recommonmark to MyST
1 parent b9b630a commit b2e42f8

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

docs/conf.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
3333
extensions = [
34-
'recommonmark',
34+
'myst_parser',
3535
'sphinx_rtd_theme',
3636
"sphinx_favicon",
3737
]
@@ -70,4 +70,9 @@ def setup(app):
7070

7171
favicons = [
7272
"favicon.png",
73+
]
74+
75+
myst_enable_extensions = [
76+
"attrs_inline",
77+
"colon_fence",
7378
]

docs/reference/changelog.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Changelog
22
All notable changes to this project will be documented in this file.
33

4-
## [1.22.0](https://github.com/sqlc-dev/sqlc/releases/tag/1.22.0)
4+
5+
(v1-22-0)=
6+
## [1.22.0](https://github.com/sqlc-dev/sqlc/releases/tag/v1.22.0)
57
Released 2023-09-26
68

79
### Release notes
@@ -74,7 +76,7 @@ Read more in the [managed databases](../howto/managed-databases.md) documentatio
7476
- Bump go version to latest in ci workflows (#2722)
7577

7678

77-
79+
(v1-21-0)=
7880
## [1.21.0](https://github.com/sqlc-dev/sqlc/releases/tag/v1.21.0)
7981
Released 2023-09-06
8082

@@ -205,7 +207,7 @@ environment, set to the version of the `sqlc` executable invoking it.
205207
- (deps) Bump pytz from 2023.3 to 2023.3.post1 in /docs (#2695)
206208
- (devenv) Bump go from 1.20.7 to 1.21.0 (#2702)
207209

208-
210+
(v1-20-0)=
209211
## [1.20.0](https://github.com/sqlc-dev/sqlc/releases/tag/v1.20.0)
210212
Released 2023-07-31
211213

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ idna==3.4
88
imagesize==1.4.1
99
Jinja2==3.1.2
1010
MarkupSafe==2.1.3
11+
myst-parser==2.0.0
1112
packaging==23.1
1213
Pygments==2.16.1
1314
pyparsing==3.1.1
1415
pytz==2023.3.post1
15-
recommonmark==0.7.1
1616
requests==2.31.0
1717
snowballstemmer==2.2.0
1818
Sphinx==6.2.1

0 commit comments

Comments
 (0)