directives_demo.md

Directives Demo

A list of all directives I could find, translated into MyST.

"Just triple back-tics with no directive name creates this Python code box with a copy button."

From Sphinx

Admonitions

admonition

attention

caution

danger

error

warning

hint

tip

important

note

image

figure

topic

Putting some content here.

sidebar

Sidebar Content

line block

Deprecated, and doesn't seem to work.

parsed literal

"This is the content of a parsed literal block."
"It appears to be identical to what you get from plain backtics"

code

def my_function():
  print("testing code block")
  print(2*40)

math

\aleph = 2^\aleph

rubric

epigraph

I am the sign of the letter and the designation of the division.

-- Thunder, Perfect Mind

highlights

Highlights include:
* The smog that rubs its back.
* The shadow of this red rock.

Must end with a non-list paragraph element or the attribution won't look cool.

-- The textbook of footnoted poetry 

pull-quote

A beautiful pull-quote that draws the reader in. Looks exactly like highlights and epigraphs though.

-- a brilliant observer

compound paragraph

A compound paragraph is a paragraph with things inside it like:

* lists
* literal blocks
* tables

That are still part of the same paragraph.

container

This content will be in a generic block-level container with the class "special" because that's the argument I passed to the directive.

Tables

• Restructured Text supports 3 kinds of tables.
• I can't get them to work.
• They are table, csv-table, and list table.

contents

:depth: 3

include

toctree

Hiding

:maxdepth: 2
widgets_demo