Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

extend examples #313

Merged
merged 2 commits into from
Nov 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 58 additions & 2 deletions papyri/examples.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
""""

Examples Modules
----------------
Examples Modules Heading 1
==========================

This module contains examples, none of the functions, classes or other attribute
should have any effects when called.
Expand Down Expand Up @@ -37,6 +37,62 @@
Definition 2, paragraph 2.


.. note::

An admonition note !

This is a link to `Jupyter website <jupyter.org>`__

Code (title 2)
--------------

.. code::

from package import module
module.call("string")

Math
----


.. math::

\\pi = 3.14159


"""

"""

term
: definition

## Math


## Figures

```{figure} https://via.placeholder.com/150
:width: 100px
:align: center

Figure caption
```

## Tables

```{list-table}
:header-rows: 1
:align: center

* - Header 1
- Header 2
* - Item 1 a
- Item 2 a
* - Item 1 b
- Item 2 b
```

"""

from typing import Optional, Union
Expand Down