Skip to content

Commit 400fdc1

Browse files
authored
DOC - Update kitchen sink pages (#2190)
closes #2038
1 parent f5c69c8 commit 400fdc1

File tree

9 files changed

+127
-49
lines changed

9 files changed

+127
-49
lines changed

docs/examples/kitchen-sink/admonitions.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,114 +17,149 @@ Sphinx provides several different types of admonitions.
1717
This is what admonitions are a special case of, according to the docutils
1818
documentation.
1919

20+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
21+
2022
``admonition``
2123
==============
2224

2325
.. admonition:: The one with the custom titles
2426

2527
It's got a certain charm to it.
2628

29+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
30+
2731
``attention``
2832
=============
2933

3034
.. attention::
3135

3236
Climate change is real.
3337

38+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
39+
3440
``caution``
3541
===========
3642

3743
.. caution::
3844

3945
Cliff ahead: Don't drive off it.
4046

47+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
48+
4149
``danger``
4250
==========
4351

4452
.. danger::
4553

4654
Mad scientist at work!
4755

56+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
57+
4858
``error``
4959
=========
5060

5161
.. error::
5262

5363
Does not compute.
5464

65+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
66+
5567
``hint``
5668
========
5769

5870
.. hint::
5971

6072
Insulators insulate, until they are subject to ______ voltage.
6173

74+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
75+
6276
``important``
6377
=============
6478

6579
.. important::
6680

6781
Tech is not neutral, nor is it apolitical.
6882

83+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
84+
6985
``note``
7086
========
7187

7288
.. note::
7389

7490
This is a note.
7591

92+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
93+
7694
``seealso``
7795
===========
7896

7997
.. seealso::
8098

8199
Other relevant information.
82100

101+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
102+
83103
``tip``
84104
=======
85105

86106
.. tip::
87107

88108
25% if the service is good.
89109

110+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
111+
90112
``todo``
91113
========
92114

93115
.. todo::
94116

95117
This needs the ``sphinx.ext.todo`` extension.
96118

119+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
120+
97121
``warning``
98122
===========
99123

100124
.. warning::
101125

102126
Reader discretion is strongly advised.
103127

128+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
129+
104130
``versionadded``
105131
================
106132

107133
.. versionadded:: v0.1.1
108134

109135
Here's a version added message.
110136

137+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
138+
111139
``versionchanged``
112140
==================
113141

114142
.. versionchanged:: v0.1.1
115143

116144
Here's a version changed message.
117145

146+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
147+
118148
``deprecated``
119149
==============
120150

121151
.. deprecated:: v0.1.1
122152

123153
Here's a deprecation message.
124154

155+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.
156+
157+
125158
``versionremoved``
126159
==================
127160

128161
.. versionremoved:: v0.1.1
129162

130163
Here's a version removed message.
164+
165+
We also support *italic*, **bold**, ``code``, `links <https://www.sphinx-doc.org/en/master/>`_, and more.

docs/examples/kitchen-sink/generic.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Licensed under Creative Commons Attribution-ShareAlike 4.0 International License
44
SPDX-License-Identifier: CC-BY-SA-4.0
55
6-
.. |EXAMPLE| image:: https://source.unsplash.com/32x32/daily?icon
6+
.. |EXAMPLE| image:: https://picsum.photos/16/16
77
:width: 1em
88

99
=============
@@ -28,9 +28,9 @@ a :sup:`superscript`, :emphasis:`emphasis`, :strong:`strong`, and
2828
Hyperlinks
2929
----------
3030

31-
It is a website, so it'll have hyperlinks like http://www.python.org (inline),
31+
It is a website, so it'll have hyperlinks like https://www.python.org/ (inline),
3232
or Python_ (external reference), example_ (internal reference),
33-
`Python web site <http://www.python.org>`__ (external hyperlinks with embedded
33+
`Python web site <https://www.python.org/>`__ (external hyperlinks with embedded
3434
URI), footnote references (manually numbered [1]_, anonymous auto-numbered [#]_,
3535
labeled auto-numbered [#label]_, or symbolic [*]_), citation references ([12]_),
3636
substitution references (|example|), and _`inline hyperlink targets`
@@ -110,7 +110,7 @@ Sidebar
110110

111111
Lorem ipsum dolor sit amet consectetur adipisicing elit.
112112

113-
.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
113+
.. image:: https://picsum.photos/200/200
114114

115115
Lorem ipsum dolor sit amet consectetur adipisicing elit.
116116

@@ -199,7 +199,7 @@ Targets_.
199199

200200
Explicit external targets are interpolated into references such as "Python_".
201201

202-
.. _Python: http://www.python.org/
202+
.. _Python: https://www.python.org/
203203

204204
Targets may be indirect and anonymous. Thus `this phrase`__ may also
205205
refer to the Targets_ section.
@@ -268,4 +268,4 @@ voluptatem officia culpa optio atque. Quaerat sed quibusdam ratione nam.
268268
Download Links
269269
==============
270270

271-
:download:`This long long long long long long long long long long long long long long long download link should wrap white-spaces <https://source.unsplash.com/200x200/daily?cute+puppy>`
271+
:download:`This long long long long long long long long long long long long long long long download link should wrap white-spaces <https://picsum.photos/200/200>`

docs/examples/kitchen-sink/images.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ Images
1212

1313
An image:
1414

15-
.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
15+
.. image:: https://picsum.photos/200/200
1616
:height: 200
1717
:width: 200
1818

1919
A clickable image:
2020

21-
.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
22-
:target: https://unsplash.com/
21+
.. image:: https://picsum.photos/200/200
22+
:target: https://picsum.photos/
2323
:height: 200
2424
:width: 200
2525

26-
.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
26+
.. image:: https://picsum.photos/200/200
2727
:align: right
2828
:height: 200
2929
:width: 200
@@ -43,7 +43,7 @@ sapiente veritatis doloribus accusantium molestiae modi recusandae
4343
excepturi facere, corrupti expedita sit nihil temporibus eius sequi
4444
animi, illo libero labore fuga.
4545

46-
.. image:: https://source.unsplash.com/200x200/daily?cute+puppy
46+
.. image:: https://picsum.photos/200/200
4747
:align: left
4848
:height: 200
4949
:width: 200
@@ -66,7 +66,7 @@ animi, illo libero labore fuga.
6666
Figures
6767
-------
6868

69-
.. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
69+
.. figure:: https://picsum.photos/200/200
7070
:alt: reStructuredText, the markup syntax
7171

7272
A figure is an image with a caption and/or a legend:
@@ -83,7 +83,7 @@ Figures
8383

8484
A figure directive with center alignment
8585

86-
.. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
86+
.. figure:: https://picsum.photos/200/200
8787
:align: center
8888

8989
This caption should be centered.

docs/examples/kitchen-sink/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Kitchen Sink
88

99
.. note::
1010

11-
The Kitchen Sink was generated from the `Sphinx Themes website <https://sphinx-themes.org/>`_, a community-supported showcase of themes for `Sphinx <https://www.sphinx-doc.org/>`_.
11+
The Kitchen Sink was generated from the
12+
`Sphinx Themes website <https://sphinx-themes.org/>`_, a community-supported showcase
13+
of themes for `Sphinx <https://www.sphinx-doc.org/>`_.
1214
Check it out to see other great themes.
1315

1416
.. button-link:: https://sphinx-themes.org

docs/examples/kitchen-sink/lists.rst

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Field list
105105
Glossary
106106
--------
107107

108-
This is a glossary with definition terms for thing like :term:`Writing`:
108+
This is a glossary with definition terms for things like :term:`Writing`:
109109

110110
.. glossary::
111111

@@ -174,9 +174,9 @@ Complex
174174

175175
* Nested item 3.
176176

177-
- ``inline literall``
178-
- ``inline literall``
179-
- ``inline literall``
177+
- ``inline literal``
178+
- ``inline literal``
179+
- ``inline literal``
180180
- This item has multiple paragraphs.
181181

182182
This item has multiple paragraphs.
@@ -189,13 +189,13 @@ Second list level
189189
^^^^^^^^^^^^^^^^^
190190

191191
- here is a list in a second-level section.
192-
- `yahoo <http://www.yahoo.com>`_
193-
- `yahoo <http://www.yahoo.com>`_
192+
- `yahoo <https://www.yahoo.com/>`_
193+
- `yahoo <https://www.yahoo.com/>`_
194194

195-
- `yahoo <http://www.yahoo.com>`_
195+
- `yahoo <https://www.yahoo.com/>`_
196196
- here is an inner bullet ``oh``
197197

198-
- one more ``with an inline literally``. `yahoo <http://www.yahoo.com>`_
198+
- one more ``with an inline literally``. `yahoo <https://www.yahoo.com/>`_
199199

200200
heh heh. child. try to beat this embed:
201201

@@ -204,8 +204,8 @@ Second list level
204204
:linenos:
205205
:lines: 10-20
206206

207-
- and another. `yahoo <http://www.yahoo.com>`_
208-
- `yahoo <http://www.yahoo.com>`_
207+
- and another. `yahoo <https://www.yahoo.com/>`_
208+
- `yahoo <https://www.yahoo.com/>`_
209209
- ``hi``
210210
- how about an admonition?
211211

@@ -217,15 +217,15 @@ Second list level
217217
But deeper down the rabbit hole
218218
"""""""""""""""""""""""""""""""
219219

220-
- I kept saying that, "deeper down the rabbit hole". `yahoo <http://www.yahoo.com>`_
220+
- I kept saying that, "deeper down the rabbit hole". `yahoo <https://www.yahoo.com/>`_
221221

222-
- I cackle at night `yahoo <http://www.yahoo.com>`_.
222+
- I cackle at night `yahoo <https://www.yahoo.com/>`_.
223223
- I'm so lonely here in GZ ``guangzhou``
224-
- A man of python destiny, hopes and dreams. `yahoo <http://www.yahoo.com>`_
224+
- A man of python destiny, hopes and dreams. `yahoo <https://www.yahoo.com/>`_
225225

226-
- `yahoo <http://www.yahoo.com>`_
226+
- `yahoo <https://www.yahoo.com/>`_
227227

228-
- `yahoo <http://www.yahoo.com>`_ ``hi``
228+
- `yahoo <https://www.yahoo.com/>`_ ``hi``
229229
- ``destiny``
230230

231231
Hlists
@@ -237,20 +237,20 @@ Hlists
237237
- First item
238238
- Second item
239239
- Third item
240-
- Forth item
240+
- Fourth item
241241
- Fifth item
242-
- Sixths item
242+
- Sixth item
243243

244244
.. rubric:: Hlist with images
245245

246246
.. hlist::
247247
:columns: 2
248248

249-
- .. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
249+
- .. figure:: https://picsum.photos/200/200
250250

251251
This is a short caption for a figure.
252252

253-
- .. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
253+
- .. figure:: https://picsum.photos/200/200
254254

255255
This is a long caption for a figure. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
256256
Donec porttitor dolor in odio posuere, vitae ornare libero mattis. In lobortis justo vestibulum nibh aliquet, non.

docs/examples/kitchen-sink/structure.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ luctus efficitur arcu. Cras ut dictum mi. Nulla congue interdum lorem, semper se
8383
Document Subsection
8484
-------------------
8585

86-
.. figure:: https://source.unsplash.com/200x200/daily?cute+puppy
86+
.. figure:: https://picsum.photos/200/200
8787
:align: right
8888
:figwidth: 200px
8989

0 commit comments

Comments
 (0)