Skip to content

Commit 3dfef80

Browse files
committed
Simplify sample
1 parent f26a315 commit 3dfef80

File tree

1 file changed

+17
-80
lines changed

1 file changed

+17
-80
lines changed

sample/index.rst

Lines changed: 17 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Comment Support
1515
.. This is a comment that demonstrates comment support.
1616
Comments should not appear in the final output.
1717
18-
Text Formatting Examples
19-
~~~~~~~~~~~~~~~~~~~~~~~~~
18+
Text Formatting
19+
~~~~~~~~~~~~~~~
2020

2121
.. rest-example::
2222

@@ -26,37 +26,17 @@ Text Formatting Examples
2626

2727
This text has :strike:`strike` formatting and :del:`deleted text` as well.
2828

29-
Colored Text
30-
~~~~~~~~~~~~
31-
32-
.. rest-example::
33-
3429
The builder supports colored text using `sphinxcontrib-text-styles <https://sphinxcontrib-text-styles.readthedocs.io/>`_:
3530

3631
This is :text-red:`red text`, :text-blue:`blue text`, :text-green:`green text`, :text-yellow:`yellow text`, :text-orange:`orange text`, :text-purple:`purple text`, :text-pink:`pink text`, :text-brown:`brown text`, and :text-gray:`gray text`.
3732

38-
Background Colors
39-
~~~~~~~~~~~~~~~~~~
40-
41-
.. rest-example::
42-
4333
The builder also supports background colors using `sphinxcontrib-text-styles <https://sphinxcontrib-text-styles.readthedocs.io/>`_:
4434

4535
This is :bg-red:`red background text`, :bg-blue:`blue background text`, :bg-green:`green background text`, :bg-yellow:`yellow background text`, :bg-orange:`orange background text`, :bg-purple:`purple background text`, :bg-pink:`pink background text`, :bg-brown:`brown background text`, and :bg-gray:`gray background text`.
4636

47-
Other Text Styles
48-
~~~~~~~~~~~~~~~~~~
49-
50-
.. rest-example::
51-
5237
The builder supports additional text styles: :text-bold:`bold text`, :text-italic:`italic text`, :text-mono:`monospace text`, :text-strike:`strikethrough text`, and :text-underline:`underlined text`.
5338

54-
Keyboard Shortcuts
55-
~~~~~~~~~~~~~~~~~~
56-
57-
.. rest-example::
58-
59-
The builder supports keyboard shortcuts using the standard ``:kbd:`` role: Press :kbd:`Ctrl+C` to copy, :kbd:`Ctrl+V` to paste, and :kbd:`Ctrl+Z` to undo.
39+
The builder supports keyboard shortcuts using the standard ``:kbd:`` role: Press :kbd:`Ctrl+C` to copy, :kbd:`Ctrl+V` to paste.
6040

6141
Admonitions
6242
~~~~~~~~~~~
@@ -131,8 +111,8 @@ Including Files
131111
:language: python
132112
:caption: Example **Configuration** File
133113

134-
Nested Content in Bullet Lists
135-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114+
Bullet Lists
115+
~~~~~~~~~~~~
136116

137117
.. rest-example::
138118

@@ -228,7 +208,7 @@ Task Lists
228208
3. [ ] Task C
229209

230210
Block Quotes
231-
------------
211+
~~~~~~~~~~~~
232212

233213
.. rest-example::
234214

@@ -238,8 +218,8 @@ Block Quotes
238218
block quote with
239219
multiple lines.
240220

241-
Table Example
242-
-------------
221+
Tables
222+
~~~~~~
243223

244224
.. rest-example::
245225

@@ -256,11 +236,6 @@ Table Example
256236
| Normal text | `link2 <https://google.com>`_ |
257237
+----------------------+-------------------------------+
258238

259-
List Table with Stub (Header) Column
260-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
261-
262-
.. rest-example::
263-
264239
.. list-table::
265240
:header-rows: 1
266241
:stub-columns: 1
@@ -278,84 +253,46 @@ List Table with Stub (Header) Column
278253
- Supports ``inline code``
279254
- ✅ Working
280255

281-
Image Examples
282-
--------------
283-
284-
Simple Image
285-
~~~~~~~~~~~~
256+
Images
257+
~~~~~~
286258

287259
.. rest-example::
288260

289261
.. image:: https://images.unsplash.com/photo-1506905925346-21bda4d32df4?w=800&h=600&fit=crop
290262

291-
Image with Alt Text (External)
292-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
293-
294-
.. rest-example::
295-
296263
.. image:: https://images.unsplash.com/photo-1506905925346-21bda4d32df4?w=800&h=600&fit=crop
297264
:alt: Mountain landscape with snow-capped peaks
298265

299-
Image with Alt Text
300-
~~~~~~~~~~~~~~~~~~~
301-
302-
.. rest-example::
303-
304266
.. image:: https://images.unsplash.com/photo-1506905925346-21bda4d32df4?w=800&h=600&fit=crop
305-
:alt: Beautiful mountain scenery
306-
307-
Local Image Example
308-
~~~~~~~~~~~~~~~~~~~
309-
310-
.. rest-example::
311267

312268
.. image:: _static/test-image.png
313-
:alt: Local test image
314-
315-
SVG support
316-
~~~~~~~~~~~
317-
318-
.. rest-example::
319269

320270
.. image:: _static/camera.svg
321271

322-
Video Examples
323-
--------------
324-
325-
Simple Video
326-
~~~~~~~~~~~~
272+
Video
273+
~~~~~
327274

328275
.. rest-example::
329276

330277
.. video:: https://www.w3schools.com/html/mov_bbb.mp4
331278

332-
Video with Caption
333-
~~~~~~~~~~~~~~~~~~
334-
335-
.. rest-example::
336-
337279
.. video:: https://www.w3schools.com/html/mov_bbb.mp4
338-
:caption: Sample video demonstrating video support
339-
340-
Local Video Example
341-
~~~~~~~~~~~~~~~~~~~
342-
343-
.. rest-example::
280+
:caption: Sample video demonstrating video support with a caption
344281

345282
.. video:: _static/test-video.mp4
346283
:caption: Local test video file
347284

348-
Audio Examples
349-
~~~~~~~~~~~~~~
285+
Audio
286+
~~~~~
350287

351288
.. rest-example::
352289

353290
.. audio:: https://thetestdata.com/assets/audio/wav/thetestdata-sample-wav-2.wav
354291

355292
.. audio:: _static/test-audio.wav
356293

357-
PDF Support
358-
~~~~~~~~~~~
294+
PDF
295+
~~~
359296

360297
.. rest-example::
361298

0 commit comments

Comments
 (0)