1. Reference¶
Lorem ipsum dolor sit amet, magna offendit
similique ne nec.
Ex doming sanctus labores pro, est ne dico simul laboramus.
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
Cu ipsum percipit electram sed. Per recusabo convenire definiebas an.
Cu atomorum splendide nec, id qui suas urbanitas.
1.1. Functions¶
-
foo
(bar, baz=None)¶ Lorem ipsum dolor sit amet,
magna offendit
similique ne nec. Ex doming sanctus labores pro, est ne dico simul laboramus.Note
Admonition
inside
function docstring.- Parameters
bar (str) –
Lorem ipsum dolor sit amet, magna offendit similique ne nec.
Tip
Admonition inside
function
parameters comment.baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
bar
(baz, *args, **kwargs)¶ Lorem ipsum dolor sit amet, magna offendit similique ne nec. Ex doming sanctus labores pro, est ne dico simul laboramus.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
- Returns
Eam ad sint accumsan
percipitur
, dicta ubique expetendis ne sed.
1.2. Classes¶
-
class
Foo
¶ Lorem ipsum dolor sit amet, magna offendit similique ne nec. Ex doming sanctus labores pro, est ne dico simul laboramus.
Warning
Admonition inside class docstring.
-
bar
¶ Ex doming sanctus labores pro, est ne dico simul laboramus.
Note
Admonition inside attribute comment.
Blockquoute text inside admonition
-
baz
¶ Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
foo
(bar, baz)¶ Cu ipsum percipit electram sed. Per recusabo convenire definiebas an.
Tip
Admonition inside method docstring.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
static
foo_static
(bar, baz)¶ Cu atomorum splendide nec, id qui suas urbanitas.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
classmethod
foo_class
(bar, baz)¶ Quem wisi elaboraret ut pro. Qui augue comprehensam ne.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
Warning
Admonition inside method return comment.
-
-
class
Bar
¶ Lorem ipsum dolor sit amet, magna offendit similique ne nec. Ex doming sanctus labores pro, est ne dico simul laboramus.
-
bar
¶ Ex doming sanctus labores pro, est ne dico simul laboramus.
-
baz
¶ Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
foo
(bar, baz)¶ Cu ipsum percipit electram sed. Per recusabo convenire definiebas an.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
static
foo_static
(bar, baz)¶ Cu atomorum splendide nec, id qui suas urbanitas.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-
classmethod
foo_class
(bar, baz)¶ Quem wisi elaboraret ut pro. Qui augue comprehensam ne.
- Parameters
bar (str) – Lorem ipsum dolor sit amet, magna offendit similique ne nec.
baz (bool) – Ex doming sanctus labores pro, est ne dico simul laboramus.
- Returns
Eam ad sint accumsan percipitur, dicta ubique expetendis ne sed.
-