File: docs-Replace-deprecated-MyST-code.patch

package info (click to toggle)
python-pyinstrument 5.1.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,624 kB
  • sloc: python: 6,713; ansic: 897; makefile: 46; sh: 26; javascript: 18
file content (28 lines) | stat: -rw-r--r-- 814 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
From: Carsten Schoenert <c.schoenert@t-online.de>
Date: Sat, 31 May 2025 14:21:21 +0200
Subject: docs: Replace deprecated MyST code

Using the 'html_meta' key directly is deprecated.
The now useable syntax is explained on the RTD site for MyST.
https://myst-parser.readthedocs.io/en/latest/configuration.html#setting-html-metadata

Otherwise we will see this:
/build/python-pyinstrument-5.0.2/docs/home.md.rst:1: WARNING: top-level 'html_meta' key is deprecated, place under 'myst' key instead [myst.topmatter]
---
 docs/home.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/home.md b/docs/home.md
index 09d02bd..7e07936 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -1,6 +1,7 @@
 ---
-html_meta:
-    title: Home
+myst:
+    html_meta:
+        "title": "Home"
 hide-toc:
 ---