`Additional` `Samples` ¶

Various examples of styling applied to Sphinx constructs. You can view the source of this page to see the specific reStructuredText used to create these examples.

Subpages ¶

Suppages get bread crumbs when they are not at the top level.

Level 1 page
- 1. Subsubpage
- 2. Second Subsubpage

Headings ¶

This is a first level heading ( h1 ).

Sub-Heading ¶

This is a second level heading ( h2 ).

Sub-Sub-Heading ¶

This is a third level heading ( h3 ).

Code ¶

The theme uses pygments for inline code text and

         multiline
code text

Here’s an included example with line numbers.

It also works with existing Sphinx highlighting:

         <html>
  <body>Hello World</body>
</html>

        

         def hello():
    """Greet."""
    return "Hello World"

        

         /**
 * Greet.
 */
function hello(): {
  return "Hello World";
}

        

Admonitions ¶

The theme uses the admonition classes for Sphinx admonitions.

Note ¶

참고

This is a note .

Todo ¶

할 일

It is essential to complete todo items.

Warning ¶

경고

This is a warning .

Danger ¶

위험

This is danger -ous.

Attention ¶

주의

Do I have your attention ?

Caution ¶

조심

Use caution !

Error ¶

오류

You have made a grave error .

Hint ¶

힌트

Can you take a hint ?

Important ¶

중요

It is important to correctly use admonitions.

Tip ¶

팁

Please tip your waiter.

Custom Admonitions ¶

Custom

You can create your own admonitions with the default style.

Footnotes ¶

I have footnoted a first item 1 and second item 2 . This also references the second item 2 .

Footnotes

1: My first footnote.
2 ( 1 , 2 ): My second footnote.

Icons ¶

The following template HTML:

         <span style="font-size: 2rem;" class="md-icon">&#xe869;</span>

        

translates to a the site’s icon:



The material icon font provides hundreds to choose from. You can use the <i> tag or the <span> tag.

Tables ¶

Here are some examples of Sphinx tables . The Sphinx Material all classes and only applies the default style to classless tables. If you want to use a custom table class, you will need to do two thing. First, apply it using .. cssclass:: custom-class and then add it to your configuration’s table_classes variable.

Grid ¶

A grid table:

Header1	Header2	Header3	Header4
row1, cell1	cell2	cell3	cell4
row2 …	…	…
…	…	…

Simple ¶

A simple table:

H1	H2	H3
cell1	cell2	cell3
…	…	…
…	…	…

User-styled Table ¶

참고

table_classes is set to [《plain》] in the site’s configuration. Only plain remains as the class of the table. Other standard classes applied by Sphinx are removed.

This is feature demonstration. There is no css for the plain class, and so this is completely unstyled.

User	Styled	Table
cell1	cell2	cell3
…	…	…
…	…	…

List Tables ¶

A List Table ¶
Column 1	Column 2
Item 1	Item 2

Alignment ¶

경고

Alignment is not currently working as expected.

Center Aligned ¶
Column 1	Column 2
Item 1	Item 2

Right Aligned ¶
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

Code Documentation ¶

An example Python function.

format_exception ( etype , value , tb [ , limit=None ] ) ¶

Format the exception with a traceback.

매개변수

etype – exception type
value – exception value
tb – traceback object
limit ( integer or None ) – maximum number of stack frames to show

반환 형식

list of strings

An example JavaScript function.

class MyAnimal ( name [ , age ] ) ¶

인수

name ( string ) – The name of the animal
age ( number ) – an optional age for the animal

Glossaries ¶

environment: A structure where information about all documents under the root is saved, and used for cross-referencing. The environment is pickled after the parsing stage, so that successive runs only need to read and parse new and changed documents.
source directory: The directory which, including its subdirectories, contains all source files for one Sphinx project.

Math ¶

\[ \begin{align}\begin{aligned}(a + b)^2 = a^2 + 2ab + b^2\\(a - b)^2 = a^2 - 2ab + b^2\end{aligned}\end{align} \]

\[\begin{split}(a + b)^2 &= (a + b)(a + b) \\ &= a^2 + 2ab + b^2\end{split}\]

\begin{eqnarray} y & = & ax^2 + bx + c \\ f(x) & = & x^2 + 2xy + y^2 \end{eqnarray}

Production Lists ¶

try_stmt  ::=  try1_stmt | try2_stmt
try1_stmt ::=  "try" ":" suite
               ("except" [expression ["," target]] ":" suite)+
               ["else" ":" suite]
               ["finally" ":" suite]
try2_stmt ::=  "try" ":" suite
               "finally" ":" suite

Additional Samples ¶