Skip to content

Commit 2b55e09

Browse files
authored
Merge pull request #58 from openalea/release
Doc
2 parents 208ac72 + f6193df commit 2b55e09

File tree

4 files changed

+51
-10
lines changed

4 files changed

+51
-10
lines changed

doc/examples/user/lpymagic.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. currentmodule:: openalea.widgets.lpymagic
2+
3+
lpymagic API
4+
===============================================
5+
.. automodule:: openalea.widgets.lpymagic
6+
:members:
7+
:exclude-members: read_data
8+
:undoc-members:
9+
:inherited-members:
10+
:show-inheritance:
11+
:synopsis: Define a set of methods to ease the lpymagic and simulation
12+
13+
Download the source file :download:`../../src/openalea/widgets/lpymagic.py`.

doc/examples/user/mtg.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. currentmodule:: openalea.widgets.mtg
2+
3+
mtg API
4+
===============================================
5+
.. automodule:: openalea.widgets.mtg
6+
:members:
7+
:exclude-members: read_data
8+
:undoc-members:
9+
:inherited-members:
10+
:show-inheritance:
11+
:synopsis: Define a set of methods to ease the mtg and simulation
12+
13+
Download the source file :download:`../../src/openalea/widgets/mtg.py`.

doc/examples/user/plantgl.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. currentmodule:: openalea.widgets.plantgl
2+
3+
plantgl API
4+
===============================================
5+
.. automodule:: openalea.widgets.plantgl
6+
:members:
7+
:exclude-members: read_data
8+
:undoc-members:
9+
:inherited-members:
10+
:show-inheritance:
11+
:synopsis: Define a set of methods to ease the plantgl and simulation
12+
13+
Download the source file :download:`../../src/openalea/widgets/plantgl.py`.

doc/index.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
Welcome to openalea.widgets's documentation!
33
======================================================
44

5-
.. sidebar:: Summary
5+
.. figure:: _static/front_page.png
6+
7+
widgets is a set of OpenAlea widgets for jupyter notebooks allowing to:
8+
9+
- use a magic to use LPy language
10+
- display interactive 3D plant architectures, using openalea.plantgl
11+
- display MTG to explore for instance class and number of vertices, number of scales, properties, using Pyvis
612

7-
:Version: |version|
8-
:Release: |release|
9-
:Date: |today|
10-
:Author: See `Authors`_ section
11-
:License: See `License`_ section
1213

1314
.. toctree::
1415
:maxdepth: 1
@@ -19,13 +20,14 @@ Welcome to openalea.widgets's documentation!
1920
authors
2021
license
2122

22-
23-
2423
.. seealso::
2524

2625
More documentation on OpenAlea can be found on the
2726
`OpenAlea <https://openalea.readthedocs.io>`__ website.
2827

28+
Indices and tables
29+
==================
2930

30-
31-
31+
* :ref:`genindex`
32+
* :ref:`modindex`
33+
* :ref:`search`

0 commit comments

Comments
 (0)