Skip to content

Commit 6e01dbf

Browse files
committed
docs: Use hyphenated versioning admonitions
Signed-off-by: Stephen Finucane <stephen@that.guru>
1 parent deb736f commit 6e01dbf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+937
-937
lines changed

doc/development/howtos/builders.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Configuring builders
44
Discover builders by entry point
55
--------------------------------
66

7-
.. versionadded:: 1.6
7+
.. version-added:: 1.6
88

99
:term:`builder` extensions can be discovered by means of `entry points`_ so
1010
that they do not have to be listed in the :confval:`extensions` configuration

doc/development/html_themes/index.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
HTML theme development
44
======================
55

6-
.. versionadded:: 0.6
6+
.. version-added:: 0.6
77

88
.. note::
99

@@ -82,7 +82,7 @@ and the corresponding default value.
8282
These options can be overridden by the user in :confval:`html_theme_options`
8383
and are accessible from all templates as ``theme_<name>``.
8484

85-
.. versionadded:: 7.3
85+
.. version-added:: 7.3
8686
``theme.toml`` support.
8787

8888
.. _TOML: https://toml.io/en/
@@ -155,10 +155,10 @@ Python :mod:`configparser` module) and has the following structure:
155155
These options can be overridden by the user in :confval:`html_theme_options`
156156
and are accessible from all templates as ``theme_<name>``.
157157

158-
.. versionadded:: 1.7
158+
.. version-added:: 1.7
159159
sidebar settings
160160

161-
.. versionchanged:: 5.1
161+
.. version-changed:: 5.1
162162

163163
The stylesheet setting accepts multiple CSS filenames
164164

@@ -178,7 +178,7 @@ The required argument is a path to a directory containing a ``theme.conf`` file.
178178
The programme will write a ``theme.toml`` file in the same directory,
179179
and will not modify the original ``theme.conf`` file.
180180

181-
.. versionadded:: 7.3
181+
.. version-added:: 7.3
182182

183183
.. _distribute-your-theme:
184184

@@ -211,13 +211,13 @@ using the :meth:`~sphinx.application.Sphinx.add_html_theme` API:
211211
If your theme package contains two or more themes, please call
212212
``add_html_theme()`` twice or more.
213213

214-
.. versionadded:: 1.2
214+
.. version-added:: 1.2
215215
'sphinx_themes' entry_points feature.
216216

217-
.. versionchanged:: 1.6
217+
.. version-changed:: 1.6
218218
``sphinx_themes`` entry_points has been deprecated.
219219

220-
.. versionadded:: 1.6
220+
.. version-added:: 1.6
221221
``sphinx.html_themes`` entry_points feature.
222222

223223

@@ -236,7 +236,7 @@ The :confval:`!stylesheets` setting can be used to add custom CSS files to a the
236236
Styling search result entries by category
237237
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238238

239-
.. versionadded:: 8.0
239+
.. version-added:: 8.0
240240

241241
.. note::
242242

@@ -330,7 +330,7 @@ When a documentation project is built with that theme,
330330
the output directory will contain a ``_static/theme_styles.css`` file
331331
where all template tags have been processed.
332332

333-
.. versionchanged:: 7.4
333+
.. version-changed:: 7.4
334334

335335
The preferred suffix for static templates is now ``.jinja``, in line with
336336
the Jinja project's `recommended file extension`_.

doc/development/html_themes/templating.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ in the future.
305305
The relative path to the HTML favicon image from the current document, or
306306
URL to the favicon, or ``''``.
307307

308-
.. versionadded:: 4.0
308+
.. version-added:: 4.0
309309

310310
.. data:: file_suffix
311311

@@ -331,15 +331,15 @@ in the future.
331331
The relative path to the HTML logo image from the current document, or URL
332332
to the logo, or ``''``.
333333

334-
.. versionadded:: 4.0
334+
.. version-added:: 4.0
335335

336336
.. data:: master_doc
337337
root_doc
338338

339339
The value of :confval:`master_doc` or :confval:`root_doc` (aliases),
340340
for usage with :func:`pathto`.
341341

342-
.. versionadded:: 4.0
342+
.. version-added:: 4.0
343343
The :data:`!root_doc` template variable.
344344

345345
.. data:: pagename
@@ -383,7 +383,7 @@ in the future.
383383
The fourth element can be one of: ``alpha``, ``beta``, ``rc``, ``final``.
384384
``final`` always has 0 as the last element.
385385

386-
.. versionadded:: 4.2
386+
.. version-added:: 4.2
387387

388388
.. data:: docutils_version_info
389389

@@ -392,14 +392,14 @@ in the future.
392392
The fourth element can be one of: ``alpha``, ``beta``, ``candidate``, ``final``.
393393
``final`` always has 0 as the last element.
394394

395-
.. versionadded:: 5.0.2
395+
.. version-added:: 5.0.2
396396

397397
.. data:: styles
398398

399399
A list of the names of the main stylesheets as given by the theme or
400400
:confval:`html_style`.
401401

402-
.. versionadded:: 5.1
402+
.. version-added:: 5.1
403403

404404
.. data:: title
405405

doc/extdev/event_callbacks.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Here is a more detailed list of these events.
9494

9595
Emitted when the config object has been initialized.
9696

97-
.. versionadded:: 1.8
97+
.. version-added:: 1.8
9898

9999
.. event:: builder-inited (app)
100100

@@ -118,7 +118,7 @@ Here is a more detailed list of these events.
118118
that the environment has determined.
119119
You can return a list of docnames to re-read in addition to these.
120120

121-
.. versionadded:: 1.1
121+
.. version-added:: 1.1
122122

123123
.. event:: env-purge-doc (app, env, docname)
124124

@@ -135,7 +135,7 @@ Here is a more detailed list of these events.
135135
When a source file has been changed, the cache's entries for the file are cleared,
136136
since the module declarations could have been removed from the file.
137137

138-
.. versionadded:: 0.5
138+
.. version-added:: 0.5
139139

140140
.. event:: env-before-read-docs (app, env, docnames)
141141

@@ -153,7 +153,7 @@ Here is a more detailed list of these events.
153153
You can also remove document names; do this with caution since it will make
154154
Sphinx treat changed files as unchanged.
155155

156-
.. versionadded:: 1.3
156+
.. version-added:: 1.3
157157

158158
.. event:: source-read (app, docname, content)
159159

@@ -172,7 +172,7 @@ Here is a more detailed list of these events.
172172
LaTeX, you can use a regular expression to replace ``$...$`` by
173173
``:math:`...```.
174174

175-
.. versionadded:: 0.5
175+
.. version-added:: 0.5
176176

177177
.. event:: include-read (app, relative_path, parent_docname, content)
178178

@@ -192,7 +192,7 @@ Here is a more detailed list of these events.
192192
You can process the ``content`` and replace this item
193193
to transform the included content, as with the :event:`source-read` event.
194194

195-
.. versionadded:: 7.2.5
195+
.. version-added:: 7.2.5
196196

197197
.. seealso:: The :dudir:`include` directive and the :event:`source-read` event.
198198

@@ -207,7 +207,7 @@ Here is a more detailed list of these events.
207207
*objtype* arguments are strings indicating object description of the object.
208208
And *contentnode* is a content for the object. It can be modified in-place.
209209

210-
.. versionadded:: 2.4
210+
.. version-added:: 2.4
211211

212212
.. event:: doctree-read (app, doctree)
213213

@@ -240,7 +240,7 @@ Here is a more detailed list of these events.
240240
or raise :class:`~sphinx.errors.NoUri` to prevent other handlers in
241241
trying and suppress a warning about this cross-reference being unresolved.
242242

243-
.. versionadded:: 0.5
243+
.. version-added:: 0.5
244244

245245
.. event:: warn-missing-reference (app, domain, node)
246246

@@ -257,7 +257,7 @@ Here is a more detailed list of these events.
257257
:confval:`nitpick_ignore` and :confval:`nitpick_ignore_regex`
258258
prevent the event from being emitted for the corresponding nodes.
259259

260-
.. versionadded:: 3.4
260+
.. version-added:: 3.4
261261

262262
.. event:: doctree-resolved (app, doctree, docname)
263263

@@ -290,7 +290,7 @@ Here is a more detailed list of these events.
290290
environment from the main process. *docnames* is a set of document names
291291
that have been read in the subprocess.
292292

293-
.. versionadded:: 1.3
293+
.. version-added:: 1.3
294294

295295
.. event:: env-updated (app, env)
296296

@@ -305,9 +305,9 @@ Here is a more detailed list of these events.
305305
will then be considered updated, and will be (re-)written during the writing
306306
phase.
307307

308-
.. versionadded:: 0.5
308+
.. version-added:: 0.5
309309

310-
.. versionchanged:: 1.3
310+
.. version-changed:: 1.3
311311
The handlers' return value is now used.
312312

313313
.. event:: env-get-updated (app, env)
@@ -328,7 +328,7 @@ Here is a more detailed list of these events.
328328
Emitted when Consistency checks phase. You can check consistency of
329329
metadata for whole of documents.
330330

331-
.. versionadded:: 1.6
331+
.. version-added:: 1.6
332332

333333
.. event:: write-started (app, builder)
334334

@@ -338,7 +338,7 @@ Here is a more detailed list of these events.
338338
Emitted before the builder starts to
339339
resolve and write documents.
340340

341-
.. versionadded:: 7.4
341+
.. version-added:: 7.4
342342

343343
.. event:: build-finished (app, exception)
344344

@@ -352,7 +352,7 @@ Here is a more detailed list of these events.
352352
raised no exception, *exception* will be ``None``. This allows to customize
353353
cleanup actions depending on the exception status.
354354

355-
.. versionadded:: 0.5
355+
.. version-added:: 0.5
356356

357357
Builder specific events
358358
-----------------------
@@ -370,7 +370,7 @@ These events are emitted by specific builders.
370370

371371
You can add pages to write by returning an iterable from this event.
372372

373-
.. versionadded:: 1.0
373+
.. version-added:: 1.0
374374

375375
.. event:: html-page-context (app, pagename, templatename, context, doctree)
376376

@@ -406,9 +406,9 @@ These events are emitted by specific builders.
406406
:meth:`.Sphinx.add_js_file` and :meth:`.Sphinx.add_css_file`
407407
(since v3.5.0).
408408

409-
.. versionadded:: 0.4
409+
.. version-added:: 0.4
410410

411-
.. versionchanged:: 1.3
411+
.. version-changed:: 1.3
412412
The return value can now specify a template name.
413413

414414
.. event:: linkcheck-process-uri (app, uri)
@@ -421,4 +421,4 @@ These events are emitted by specific builders.
421421

422422
The event handlers can modify the URI by returning a string.
423423

424-
.. versionadded:: 4.1
424+
.. version-added:: 4.1

doc/extdev/i18n.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ i18n API
2121
Extension internationalization (``i18n``) and localization (``l10n``) using i18n API
2222
------------------------------------------------------------------------------------
2323

24-
.. versionadded:: 1.8
24+
.. version-added:: 1.8
2525

2626
An extension may naturally come with message translations. This is briefly
2727
summarized in :func:`sphinx.locale.get_translation` help.

doc/extdev/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ To see an example of application, refer to :ref:`tutorial-extend-build`.
157157
Extension metadata
158158
------------------
159159

160-
.. versionadded:: 1.3
160+
.. version-added:: 1.3
161161

162162
The ``setup()`` function should return a dictionary.
163163
This is treated by Sphinx as metadata of the extension.
@@ -182,7 +182,7 @@ Metadata keys currently recognized are:
182182
of the stored data change, to ensure Sphinx does not try and load invalid data
183183
from a cached environment.
184184

185-
.. versionadded:: 1.8
185+
.. version-added:: 1.8
186186

187187
``'parallel_read_safe'``
188188
A boolean that specifies if parallel reading of source files

doc/extdev/testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Testing API
44
.. py:module:: sphinx.testing
55
:synopsis: Utility functions and pytest fixtures for testing.
66

7-
.. versionadded:: 1.6
7+
.. version-added:: 1.6
88

99
Utility functions and pytest fixtures for testing
1010
are provided in :py:mod:`!sphinx.testing`.

doc/internals/contributing.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,11 +230,11 @@ New unit tests should be included in the :file:`tests/` directory where necessar
230230
In general, avoid using the ``app`` fixture and ``app.build()``
231231
unless a full integration test is required.
232232

233-
.. versionadded:: 1.8
233+
.. version-added:: 1.8
234234

235235
Sphinx also runs JavaScript tests.
236236

237-
.. versionchanged:: 1.5.2
237+
.. version-changed:: 1.5.2
238238
Sphinx was switched from nose to pytest.
239239

240240

0 commit comments

Comments
 (0)