Instructions

Instructions#

Note

Currently, you need to look directly at the code to understand how to type the various commands. To do: write the syntax as syntax.

Supported files for Jupyter book#

It is possible to add Jupyter Notebooks (.ipynb) or markdown (.md) files in the book.

Main markdown commands#

  • Headers: add title between #s from one to six of them.

  • Emphasis: Italic or Italic, Bold or Bold, Bold and Italic or Bold and Italic

  • Lists: As in this code.

    • Indent code for sublist elements.

  • Ordered Lists: Use number followed by periods.

    1. item 1

      1. subitem 1.1

    2. item 2

  • Links: ML git repository

  • Images:

    Images

  • Blockquote:

    This is a blockquote.

    This is a nested blockquote.

  • Footnote:

    Now create the footnote by [1].

  • Code:

    • inline code

    • Indented block of code:

      print("Hello World!")

      or indent (result in non-colored code):

        print("Hello World!")

  • Horizontal Rules (use either ---, *** or ___):

  • Tables:

    Header 1

    Header 2

    Row 1

    Data

    Row 2

    Data

  • Line brakes: To create a line break, end a line with two or more spaces and press return.

    First line.
    Second line.

  • Equations:

    • inline equation \(E=mc^2\)

    • Block equation:

    \[ \int_{\Omega} d\omega = \int_{\partial \Omega} \omega \]

    Make sure to leave a first row empty before writing the block equation for proper rendering of the book.

Roles and Directives#

They are like functions, but written in a markup language. They both serve a similar purpose, but:

Roles are inline constructs that add semantic meaning or style to text within your documents.

Directives are block-level elements that introduce special content or functionality.

It is possible to use any directive / role that is available in Sphinx. Some examples follows.

  • Here is the ref role:
    Click Introduction for the first page of the book. Can also be typed as Introduction.

  • The proper “role” is actually the doc role:
    Click Welcome for the first page of the book.

I enclose all the directives in a tab-set directive.

Note

Here is a note

Tip

Here is a tip

Hint

Here is a hint

See also

Topic to look at

Important

This is important

Warning

This is a warning

Caution

Another warning

Attention

Please, be careful

Danger

Here is a danger

Error

Here is a error

This is a two-form.

—Thomas the tank engine

Term one#

An indented explanation of term 1

A second term#

An indented explanation of term2

  • Here is a admonition directive, wich needs a specified argument:

(a possible argument)

Here is an admonition

  • Here is an example about how to change style.

To change the style of the admonition, use

Title

Note with personalized title. Also possible to use classes referring to any directive.

  • Here is an example with the dropdown class.

Tip

Here is a tip

  • Here is an example with the toggle directive.

Some hidden toggle content!

Hello World!

  • Here is an example about how to cite a directive:

Hint

Here is a hint

Using the name class it is possible to cite Reference to my hint

  • Here are other directives:

Added in version 1.2.3: Explanation of the new feature.

Changed in version 1.2.3: Explanation of the change.

Deprecated since version 1.2.3: Explanation of the deprecation.

The ::: can be used instead of ``` also in the previous directives.

Citations#

It it possible cite references that are stored in a bibtex file.
To do this, use the role: [PAP+23].

Moreover, you can insert a bibliography into your page as shown in Welcome

Learn more#

This is just a simple starter to get you started. See and learn a lot more at jupyterbook.org.

Contents