From 38fcd3310c251b6bf1e588eea0af4a13c61d3340 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 6 Oct 2024 23:46:55 -0700 Subject: [PATCH 1/5] Fix linkcheck redirects When running `sphinx-build -b linkcheck`, there are several links reported as broken, but are redirects. This PR updates the links to their current ones. --- sample-docs/kitchen-sink/admonitions.rst | 32 ++++++++++++------------ 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/sample-docs/kitchen-sink/admonitions.rst b/sample-docs/kitchen-sink/admonitions.rst index e3b873296..62ebc05b5 100644 --- a/sample-docs/kitchen-sink/admonitions.rst +++ b/sample-docs/kitchen-sink/admonitions.rst @@ -17,7 +17,7 @@ Sphinx provides several different types of admonitions. This is what admonitions are a special case of, according to the docutils documentation. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``admonition`` ============== @@ -26,7 +26,7 @@ Sphinx provides several different types of admonitions. It's got a certain charm to it. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``attention`` ============= @@ -35,7 +35,7 @@ Sphinx provides several different types of admonitions. Climate change is real. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``caution`` =========== @@ -44,7 +44,7 @@ Sphinx provides several different types of admonitions. Cliff ahead: Don't drive off it. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``danger`` ========== @@ -53,7 +53,7 @@ Sphinx provides several different types of admonitions. Mad scientist at work! - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``error`` ========= @@ -62,7 +62,7 @@ Sphinx provides several different types of admonitions. Does not compute. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``hint`` ======== @@ -71,7 +71,7 @@ Sphinx provides several different types of admonitions. Insulators insulate, until they are subject to ______ voltage. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``important`` ============= @@ -80,7 +80,7 @@ Sphinx provides several different types of admonitions. Tech is not neutral, nor is it apolitical. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``note`` ======== @@ -89,7 +89,7 @@ Sphinx provides several different types of admonitions. This is a note. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``seealso`` =========== @@ -98,7 +98,7 @@ Sphinx provides several different types of admonitions. Other relevant information. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``tip`` ======= @@ -107,7 +107,7 @@ Sphinx provides several different types of admonitions. 25% if the service is good. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``todo`` ======== @@ -116,7 +116,7 @@ Sphinx provides several different types of admonitions. This needs the ``sphinx.ext.todo`` extension. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``warning`` =========== @@ -125,7 +125,7 @@ Sphinx provides several different types of admonitions. Reader discretion is strongly advised. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``versionadded`` ================ @@ -134,7 +134,7 @@ Sphinx provides several different types of admonitions. Here's a version added message. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``versionchanged`` ================== @@ -143,7 +143,7 @@ Sphinx provides several different types of admonitions. Here's a version changed message. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. ``deprecated`` ============== @@ -152,4 +152,4 @@ Sphinx provides several different types of admonitions. Here's a deprecation message. - We also support *italic*, **bold**, ``code``, `links `_, and more. + We also support *italic*, **bold**, ``code``, `links `_, and more. From 2f79809d7a9b3817921872222e399b3bb21ccf73 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 6 Oct 2024 23:47:36 -0700 Subject: [PATCH 2/5] s/http/https --- sample-docs/kitchen-sink/lists.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/sample-docs/kitchen-sink/lists.rst b/sample-docs/kitchen-sink/lists.rst index 333f69e06..98ea2b273 100644 --- a/sample-docs/kitchen-sink/lists.rst +++ b/sample-docs/kitchen-sink/lists.rst @@ -189,13 +189,13 @@ Second list level ^^^^^^^^^^^^^^^^^ - here is a list in a second-level section. -- `yahoo `_ -- `yahoo `_ +- `yahoo `_ +- `yahoo `_ - - `yahoo `_ + - `yahoo `_ - here is an inner bullet ``oh`` - - one more ``with an inline literally``. `yahoo `_ + - one more ``with an inline literally``. `yahoo `_ heh heh. child. try to beat this embed: @@ -204,8 +204,8 @@ Second list level :linenos: :lines: 10-20 - - and another. `yahoo `_ - - `yahoo `_ + - and another. `yahoo `_ + - `yahoo `_ - ``hi`` - how about an admonition? @@ -217,15 +217,15 @@ Second list level But deeper down the rabbit hole """"""""""""""""""""""""""""""" -- I kept saying that, "deeper down the rabbit hole". `yahoo `_ +- I kept saying that, "deeper down the rabbit hole". `yahoo `_ - - I cackle at night `yahoo `_. + - I cackle at night `yahoo `_. - I'm so lonely here in GZ ``guangzhou`` -- A man of python destiny, hopes and dreams. `yahoo `_ +- A man of python destiny, hopes and dreams. `yahoo `_ - - `yahoo `_ + - `yahoo `_ - - `yahoo `_ ``hi`` + - `yahoo `_ ``hi`` - ``destiny`` Hlists From 1c7401e1fe4efa673ced01363d77bd8f543a3943 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 6 Oct 2024 23:48:07 -0700 Subject: [PATCH 3/5] s/http/https --- sample-docs/kitchen-sink/generic.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sample-docs/kitchen-sink/generic.rst b/sample-docs/kitchen-sink/generic.rst index ac863347d..d90f89f15 100644 --- a/sample-docs/kitchen-sink/generic.rst +++ b/sample-docs/kitchen-sink/generic.rst @@ -28,9 +28,9 @@ a :sup:`superscript`, :emphasis:`emphasis`, :strong:`strong`, and Hyperlinks ---------- -It is a website, so it'll have hyperlinks like http://www.python.org (inline), +It is a website, so it'll have hyperlinks like https://www.python.org (inline), or Python_ (external reference), example_ (internal reference), -`Python web site `__ (external hyperlinks with embedded +`Python web site `__ (external hyperlinks with embedded URI), footnote references (manually numbered [1]_, anonymous auto-numbered [#]_, labeled auto-numbered [#label]_, or symbolic [*]_), citation references ([12]_), substitution references (|example|), and _`inline hyperlink targets` @@ -199,7 +199,7 @@ Targets_. Explicit external targets are interpolated into references such as "Python_". -.. _Python: http://www.python.org/ +.. _Python: https://www.python.org/ Targets may be indirect and anonymous. Thus `this phrase`__ may also refer to the Targets_ section. From 9d0d462f5d2f27345c68ae4124a06527286298a1 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 6 Oct 2024 23:49:53 -0700 Subject: [PATCH 4/5] Add trailing slash --- sample-docs/kitchen-sink/generic.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sample-docs/kitchen-sink/generic.rst b/sample-docs/kitchen-sink/generic.rst index d90f89f15..7351301a9 100644 --- a/sample-docs/kitchen-sink/generic.rst +++ b/sample-docs/kitchen-sink/generic.rst @@ -28,9 +28,9 @@ a :sup:`superscript`, :emphasis:`emphasis`, :strong:`strong`, and Hyperlinks ---------- -It is a website, so it'll have hyperlinks like https://www.python.org (inline), +It is a website, so it'll have hyperlinks like https://www.python.org/ (inline), or Python_ (external reference), example_ (internal reference), -`Python web site `__ (external hyperlinks with embedded +`Python web site `__ (external hyperlinks with embedded URI), footnote references (manually numbered [1]_, anonymous auto-numbered [#]_, labeled auto-numbered [#label]_, or symbolic [*]_), citation references ([12]_), substitution references (|example|), and _`inline hyperlink targets` From 73955022057a91237460ccd21d746b7201c4efd6 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 6 Oct 2024 23:51:23 -0700 Subject: [PATCH 5/5] Add trailing slash --- sample-docs/kitchen-sink/lists.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/sample-docs/kitchen-sink/lists.rst b/sample-docs/kitchen-sink/lists.rst index 98ea2b273..10a78dfed 100644 --- a/sample-docs/kitchen-sink/lists.rst +++ b/sample-docs/kitchen-sink/lists.rst @@ -189,13 +189,13 @@ Second list level ^^^^^^^^^^^^^^^^^ - here is a list in a second-level section. -- `yahoo `_ -- `yahoo `_ +- `yahoo `_ +- `yahoo `_ - - `yahoo `_ + - `yahoo `_ - here is an inner bullet ``oh`` - - one more ``with an inline literally``. `yahoo `_ + - one more ``with an inline literally``. `yahoo `_ heh heh. child. try to beat this embed: @@ -204,8 +204,8 @@ Second list level :linenos: :lines: 10-20 - - and another. `yahoo `_ - - `yahoo `_ + - and another. `yahoo `_ + - `yahoo `_ - ``hi`` - how about an admonition? @@ -217,15 +217,15 @@ Second list level But deeper down the rabbit hole """"""""""""""""""""""""""""""" -- I kept saying that, "deeper down the rabbit hole". `yahoo `_ +- I kept saying that, "deeper down the rabbit hole". `yahoo `_ - - I cackle at night `yahoo `_. + - I cackle at night `yahoo `_. - I'm so lonely here in GZ ``guangzhou`` -- A man of python destiny, hopes and dreams. `yahoo `_ +- A man of python destiny, hopes and dreams. `yahoo `_ - - `yahoo `_ + - `yahoo `_ - - `yahoo `_ ``hi`` + - `yahoo `_ ``hi`` - ``destiny`` Hlists