FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Convert CHANGELOG and CONTRIBUTING from .rst to .md (#277) · python/python-docs-theme@c6ef663 · GitHub

  1. python
  2. python-docs-theme

Repository navigation

Commit c6ef663

Browse files
hugovk
and
StanFromIreland
authored
Convert CHANGELOG and CONTRIBUTING from .rst to .md (#277)
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
1 parent 498d07f commit c6ef663

3 files changed

Lines changed: 67 additions & 99 deletions

File tree

CHANGELOG.rst renamed to CHANGELOG.md

Lines changed: 41 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,42 @@
1-
Changelog
2-
=========
1+
# Changelog
32

4-
`2025.10 <https://github.com/python/python-docs-theme/releases/tag/2025.10>`_
5-
-------------------------------------------------------------------------------
3+
## [2025.10](https://github.com/python/python-docs-theme/releases/tag/2025.10)
64

75
* Add Romanian translation by @octaG-M in https://github.com/python/python-docs-theme/pull/272
86
* Add Arabic and Russian translations by @StanFromIreland in https://github.com/python/python-docs-theme/pull/274
97
* Add French translation by @JulienPalard in https://github.com/python/python-docs-theme/pull/275
10-
* Update authors in ``pyproject.toml`` by @StanFromIreland in https://github.com/python/python-docs-theme/pull/271
8+
* Update authors in `pyproject.toml` by @StanFromIreland in https://github.com/python/python-docs-theme/pull/271
119
* Add link to devguide in README by @StanFromIreland in https://github.com/python/python-docs-theme/pull/266
1210

13-
`2025.9.2 <https://github.com/python/python-docs-theme/releases/tag/2025.9.2>`_
14-
-------------------------------------------------------------------------------
11+
## [2025.9.2](https://github.com/python/python-docs-theme/releases/tag/2025.9.2)
1512

1613
* Add Korean and Indonesian translations from Transifex in https://github.com/python/python-docs-theme/pull/264
1714
* Add German translation by @cmaureir in https://github.com/python/python-docs-theme/pull/262
1815
* Fix compilation of translations and loading of translations on pages with html
1916
source in https://github.com/python/python-docs-theme/pull/263
2017
* Fix search button cutting off long translations in https://github.com/python/python-docs-theme/pull/268
21-
* Fix ``Copy`` button copying line numbers by @StanFromIreland in https://github.com/python/python-docs-theme/pull/270
18+
* Fix `Copy` button copying line numbers by @StanFromIreland in https://github.com/python/python-docs-theme/pull/270
2219

23-
`2025.9.1 <https://github.com/python/python-docs-theme/releases/tag/2025.9.1>`_
24-
-------------------------------------------------------------------------------
20+
## [2025.9.1](https://github.com/python/python-docs-theme/releases/tag/2025.9.1)
2521

2622
* Add Japanese, Turkish and Spanish translations from Transifex in https://github.com/python/python-docs-theme/pull/259
2723

28-
`2025.9 <https://github.com/python/python-docs-theme/releases/tag/2025.9>`_
29-
---------------------------------------------------------------------------
24+
## [2025.9](https://github.com/python/python-docs-theme/releases/tag/2025.9)
3025

3126
* Enable theme translation and add Polish by @StanFromIreland in https://github.com/python/python-docs-theme/pull/246
3227
* Add Greek translation by @lysnikolaou and @skpanagiotis in https://github.com/python/python-docs-theme/pull/256 and https://github.com/python/python-docs-theme/pull/257
3328
* Add Swedish translation by @yeager in https://github.com/python/python-docs-theme/pull/250
34-
* Add Brazilian Portuguese, Simplified Chinese and Traditional Chinese translations from `Transifex <https://explore.transifex.com/python-doc/python-docs-theme/>`_ in https://github.com/python/python-docs-theme/pull/253
29+
* Add Brazilian Portuguese, Simplified Chinese and Traditional Chinese translations from [Transifex](https://explore.transifex.com/python-doc/python-docs-theme/) in https://github.com/python/python-docs-theme/pull/253
3530

36-
`2025.5 <https://github.com/python/python-docs-theme/releases/tag/2025.5>`_
37-
---------------------------------------------------------------------------
31+
## [2025.5](https://github.com/python/python-docs-theme/releases/tag/2025.5)
3832

3933
* Make the copy button only appear when hovered over or clicked on by @kevteg in https://github.com/python/python-docs-theme/pull/243
4034

41-
`2025.4.1 <https://github.com/python/python-docs-theme/releases/tag/2025.4.1>`_
42-
-------------------------------------------------------------------------------
35+
## [2025.4.1](https://github.com/python/python-docs-theme/releases/tag/2025.4.1)
4336

4437
* Fix copy button with multiple tracebacks by @tomasr8 in https://github.com/python/python-docs-theme/pull/240
4538

46-
`2025.4 <https://github.com/python/python-docs-theme/releases/tag/2025.4>`_
47-
---------------------------------------------------------------------------
39+
## [2025.4](https://github.com/python/python-docs-theme/releases/tag/2025.4)
4840

4941
* Require Sphinx 7.3 by @AA-Turner in https://github.com/python/python-docs-theme/pull/221
5042
* Add support for Python 3.14 by @hugovk https://github.com/python/python-docs-theme/pull/236
@@ -55,26 +47,23 @@ Changelog
5547
* Remove self-closing tags by @hugovk in https://github.com/python/python-docs-theme/pull/226
5648
* Replace deprecated classifier with licence expression (PEP 639) by @hugovk in https://github.com/python/python-docs-theme/pull/237
5749

58-
`2025.2 <https://github.com/python/python-docs-theme/releases/tag/2025.2>`_
59-
---------------------------------------------------------------------------
50+
## [2025.2](https://github.com/python/python-docs-theme/releases/tag/2025.2)
6051

6152
- Note minimum requirements for Sphinx (#216)
6253
Contributed by Adam Turner
6354
- Horizontally centre the sidebar collapse button (#219)
6455
Contributed by Tomas Roun
6556
- Make sidebar width more flexible (#218)
6657
Contributed by Tomas Roun
67-
- Set ``__version__`` in the runtime package (#222)
58+
- Set `__version__` in the runtime package (#222)
6859
Contributed by Adam Turner
6960

70-
`2024.12 <https://github.com/python/python-docs-theme/releases/tag/2024.12>`_
71-
-----------------------------------------------------------------------------
61+
## [2024.12](https://github.com/python/python-docs-theme/releases/tag/2024.12)
7262

7363
- Hide header and search bar when printing (#204)
7464
Contributed by Hugo van Kemenade
7565

76-
`2024.10 <https://github.com/python/python-docs-theme/releases/tag/2024.10>`_
77-
-----------------------------------------------------------------------------
66+
## [2024.10](https://github.com/python/python-docs-theme/releases/tag/2024.10)
7867

7968
- Add support for Python 3.13 (#196)
8069
Contributed by Hugo van Kemenade
@@ -85,60 +74,53 @@ Changelog
8574
- Generate digital attestations for PyPI (PEP 740) (#198)
8675
Contributed by Hugo van Kemenade
8776

88-
`2024.6 <https://github.com/python/python-docs-theme/releases/tag/2024.6>`_
89-
---------------------------------------------------------------------------
77+
## [2024.6](https://github.com/python/python-docs-theme/releases/tag/2024.6)
9078

9179
- Add backgrounds and borders to admonitions (#190)
9280
Contributed by Hugo van Kemenade
9381
- Use different colour for 'Return value: Borrowed reference' (#188)
9482
Contributed by Hugo van Kemenade
9583

96-
`2024.4 <https://github.com/python/python-docs-theme/releases/tag/2024.4>`_
97-
---------------------------------------------------------------------------
84+
## [2024.4](https://github.com/python/python-docs-theme/releases/tag/2024.4)
9885

9986
- Add colour to version change directives (#185)
10087
Contributed by Hugo van Kemenade
101-
- Only show 'Last updated on ...' when ``last_updated`` defined (#183)
88+
- Only show 'Last updated on ...' when `last_updated` defined (#183)
10289
Contributed by Hugo van Kemenade
10390
- Use system font stack for all code (#186)
10491
Contributed by Hugo van Kemenade
10592

106-
`2024.3 <https://github.com/python/python-docs-theme/releases/tag/2024.3>`_
107-
---------------------------------------------------------------------------
93+
## [2024.3](https://github.com/python/python-docs-theme/releases/tag/2024.3)
10894

10995
- Modernise font: use system font stack to improve text readability and webpage performance (#174)
11096
Contributed by Hugo van Kemenade
11197
- Remove incorrect CSS property (#178)
11298
Contributed by Kerim Kabirov
11399

114-
`2024.2 <https://github.com/python/python-docs-theme/releases/tag/2024.2>`_
115-
---------------------------------------------------------------------------
100+
## [2024.2](https://github.com/python/python-docs-theme/releases/tag/2024.2)
116101

117102
- Do not underline navigation links (#169)
118103
Contributed by Hugo van Kemenade
119104
- Only apply underline offset to code formatting for underline visibility (#171)
120105
Contributed by Hugo van Kemenade
121106

122-
`2024.1 <https://github.com/python/python-docs-theme/releases/tag/2024.1>`_
123-
---------------------------------------------------------------------------
107+
## [2024.1](https://github.com/python/python-docs-theme/releases/tag/2024.1)
124108

125109
- Underline links for readability and a11y (#160, #166)
126110
Contributed by Hugo van Kemenade
127-
- Add ``hosted_on`` variable for a link in the footer (#165)
111+
- Add `hosted_on` variable for a link in the footer (#165)
128112
Contributed by Hugo van Kemenade
129-
- Consistently reference ``theme_root_icon`` (#163)
113+
- Consistently reference `theme_root_icon` (#163)
130114
Contributed by Marko Budiselic
131115
- Dark mode: fix contrast of footer highlight (#162)
132116
Contributed by Hugo van Kemenade
133117

134-
`2023.9 <https://github.com/python/python-docs-theme/releases/tag/2023.9>`_
135-
---------------------------------------------------------------------------
118+
## [2023.9](https://github.com/python/python-docs-theme/releases/tag/2023.9)
136119

137120
- Focus search box when pressing slash (#153)
138121
Contributed by Hugo van Kemenade
139122

140-
`2023.8 <https://github.com/python/python-docs-theme/releases/tag/2023.8>`_
141-
---------------------------------------------------------------------------
123+
## [2023.8](https://github.com/python/python-docs-theme/releases/tag/2023.8)
142124

143125
- Add Python 3.12 and 3.13 classifiers (#147)
144126
Contributed by Hugo van Kemenade
@@ -147,14 +129,13 @@ Changelog
147129
- Restore the menu on mobile devices (inadvertently broken in 2023.7) (#146)
148130
Contributed by Hugo van Kemenade
149131

150-
`2023.7 <https://github.com/python/python-docs-theme/releases/tag/2023.7>`_
151-
---------------------------------------------------------------------------
132+
## [2023.7](https://github.com/python/python-docs-theme/releases/tag/2023.7)
152133

153134
- Fix compatibility with Sphinx 7.1 (#137)
154135
Contributed by Pradyun Gedam
155136
- Enable the slash keypress to focus the search field (#141)
156137
Contributed by Mike Fiedler
157-
- Sphinx 6.2 fix: add ``nav.contents`` where ``div.topic`` is used (#138)
138+
- Sphinx 6.2 fix: add `nav.contents` where `div.topic` is used (#138)
158139
Contributed by Hugo van Kemenade
159140
- Dark mode: fix contrast for C++ specific styling (#133)
160141
Contributed by Hugo van Kemenade
@@ -163,60 +144,53 @@ Changelog
163144
- Test with Python 3.12 (#140)
164145
Contributed by Hugo van Kemenade
165146

166-
`2023.5 <https://github.com/python/python-docs-theme/releases/tag/2023.5>`_
167-
---------------------------------------------------------------------------
147+
## [2023.5](https://github.com/python/python-docs-theme/releases/tag/2023.5)
168148

169149
- Add a dark theme. (#44)
170150
Contributed by Nils K
171151
- Fix: Remove searchbox id from form. (fixes #117)
172152
Contributed by Nils K
173-
- Update ``python-docs-theme`` to work with Sphinx 5 & 6. (#99 & #127)
153+
- Update `python-docs-theme` to work with Sphinx 5 & 6. (#99 & #127)
174154
Contributed by Adam Turner
175-
- Override font for ``.sig`` for consistency with other code blocks. (#121)
155+
- Override font for `.sig` for consistency with other code blocks. (#121)
176156
Contributed by Chris Warrick
177157
- Dark mode: add class to invert image brightness. (#128)
178158
Contributed by Hugo van Kemenade
179159

180160

181-
`2023.3.1 <https://github.com/python/python-docs-theme/releases/tag/2023.3.1>`_
182-
-------------------------------------------------------------------------------
161+
## [2023.3.1](https://github.com/python/python-docs-theme/releases/tag/2023.3.1)
183162

184163
- Skip cache-busting for old Sphinx #113
185164

186165

187-
`2023.3 <https://github.com/python/python-docs-theme/releases/tag/2023.3>`_
188-
---------------------------------------------------------------------------
166+
## [2023.3](https://github.com/python/python-docs-theme/releases/tag/2023.3)
189167

190168
- Fix problem with monospace rendering in Vivaldi #104
191169
- Fix mobile nav obstructing content #96
192170
- Reduce footer margin only for desktop #106
193171
- Append a hash ?digest to CSS files for cache-busting #108
194172

195173

196-
`2022.1 <https://github.com/python/python-docs-theme/releases/tag/2022.1>`_
197-
----------------------------------------------------------------------------
174+
## [2022.1](https://github.com/python/python-docs-theme/releases/tag/2022.1)
198175

199176
- Add a configuration for license URL. (#90)
200177
- Exclude the floating navbar from CHM help. (#84)
201178
- Make sidebar scrollable and sticky (on modern browsers) (#91)
202179

203180

204-
`2021.11.1 <https://github.com/python/python-docs-theme/releases/tag/2021.11.1>`_
205-
----------------------------------------------------------------------------------
181+
## [2021.11.1](https://github.com/python/python-docs-theme/releases/tag/2021.11.1)
206182

207183
- Fix monospace again, on buggy Google Chrome (#87)
208184
Contributed by Tushar Sadhwani
209185

210186

211-
`2021.11 <https://github.com/python/python-docs-theme/releases/tag/2021.11>`_
212-
------------------------------------------------------------------------------
187+
## [2021.11](https://github.com/python/python-docs-theme/releases/tag/2021.11)
213188

214189
- Fix monospace on buggy Google Chrome (#85)
215190
Contributed by Tushar Sadhwani
216191

217192

218-
`2021.8 <https://github.com/python/python-docs-theme/releases/tag/2021.8>`_
219-
-----------------------------------------------------------------------------
193+
## [2021.8](https://github.com/python/python-docs-theme/releases/tag/2021.8)
220194

221195
- Add the copyright_url variable in the theme (#67)
222196
Contributed by jablonskidev
@@ -228,8 +202,7 @@ Changelog
228202
Contributed by Olga Bulat
229203

230204

231-
`2021.5 <https://github.com/python/python-docs-theme/releases/tag/2021.5>`_
232-
-----------------------------------------------------------------------------
205+
## [2021.5](https://github.com/python/python-docs-theme/releases/tag/2021.5)
233206

234207
- Make the theme responsive (#46)
235208
Contributed by Olga Bulat.
@@ -243,8 +216,7 @@ Changelog
243216
Contributed by Julien Palard.
244217

245218

246-
`2020.12 <https://github.com/python/python-docs-theme/releases/tag/v2020.12>`_
247-
------------------------------------------------------------------------------
219+
## [2020.12](https://github.com/python/python-docs-theme/releases/tag/v2020.12)
248220

249221
- Updated the readme, to remind user to install the package in a virtual environment. (#41)
250222
Contributed by Mariatta.
@@ -261,12 +233,10 @@ Changelog
261233
- Fixed code bgcolor and codetextcolor for Sphinx 3.1.0+ (#57)
262234
Contributed by Zhiming Wang.
263235

264-
2018.7
265-
------
266-
Corresponds to `44a8f30 <https://github.com/python/python-docs-theme/commit/44a8f306db9ec86d277a8a687538d5d51e415130>`_
236+
## 2018.7
237+
Corresponds to [44a8f30](https://github.com/python/python-docs-theme/commit/44a8f306db9ec86d277a8a687538d5d51e415130)
267238

268239

269-
`2018.2 <https://github.com/python/python-docs-theme/releases/tag/2018.2>`_
270-
---------------------------------------------------------------------------
240+
## [2018.2](https://github.com/python/python-docs-theme/releases/tag/2018.2)
271241

272242
Initial release.

‎CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# How to release
2+
3+
- Update `CHANGELOG.md`
4+
- Bump version (YYYY.MM) in `python_docs_theme/__init__.py`
5+
- Commit
6+
- Push to check tests pass on
7+
[GitHub Actions](https://github.com/python/python-docs-theme/actions)
8+
- Go to https://github.com/python/python-docs-theme/releases
9+
- Click "Draft a new release"
10+
- Click "Choose a tag"
11+
- Type the next YYYY.MM version (no leading zero) and
12+
select "**Create new tag: YYYY.MM** on publish"
13+
- Leave the "Release title" blank (it will be autofilled)
14+
- Click "Generate release notes" and amend as required
15+
- Click "Publish release"
16+
- Check the tagged [GitHub Actions build](https://github.com/python/python-docs-theme/actions/workflows/pypi-package.yml)
17+
has deployed to [PyPI](https://pypi.org/project/python-docs-theme/#history)
18+
19+
# Makefile usage
20+
21+
This project includes a simple Makefile for syncing changes to the theme with
22+
the main CPython repository. Run `make help` for details on available rules.
23+
24+
There is one configurable variable, `CPYTHON_PATH`, which should be the path
25+
to the CPython repository on your machine. By default, it points to
26+
`../cpython`.

‎CONTRIBUTING.rst‎

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL