Skip to content

Fixing Documentation #53

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.

Sign up for GitHub

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

Merged
baugetfa merged 2 commits into from
Feb 11, 2026
Merged

Fixing Documentation #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ead504b
WIP basic documentation
baugetfa Feb 6, 2026
a63ae3b
fix some error in docstring
baugetfa Feb 6, 2026
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
4 changes: 2 additions & 2 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ build:
python: "mambaforge-22.9"

conda:
environment: doc/environment.yml
environment: conda/environment.yml

sphinx:
# Path to your Sphinx configuration file.
configuration: doc/conf.py
configuration: doc/conf.py
24 changes: 20 additions & 4 deletions doc/_dvlpt/modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
src
===
CORE's API
==========

.. toctree::
:maxdepth: 4
:maxdepth: 4
:caption: Contents:

openalea
openalea.core.algo.rst
openalea.core.control.rst
openalea.core.formatting.rst
openalea.core.graph.interface.rst
openalea.core.graph.rst
openalea.core.interpreter.rst
openalea.core.plugin.builtin.rst
openalea.core.plugin.formatting.rst
openalea.core.plugin.rst
openalea.core.project.formatting.rst
openalea.core.project.rst
openalea.core.scene.rst
openalea.core.service.rst
openalea.core.system.rst
openalea.core.world.rst
openalea.core.rst
17 changes: 0 additions & 17 deletions doc/_dvlpt/openalea.core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,6 @@
openalea.core package
=====================

Subpackages
-----------

.. toctree::

openalea.core.algo
openalea.core.control
openalea.core.formatting
openalea.core.graph
openalea.core.interpreter
openalea.core.plugin
openalea.core.project
openalea.core.scene
openalea.core.service
openalea.core.system
openalea.core.world

Submodules
----------

Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Contents
:maxdepth: 1

Installation<installation.rst>
Overview of different classes<usage.rst>
Usage<usage.rst>
Reference Guide<_dvlpt/modules.rst>

Indices and tables
Expand Down
6 changes: 0 additions & 6 deletions doc/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,3 @@ that returns a list of nodes. To access to a particular node, use:
<openalea.core.node.NodeFactory object at 0x936906c>

The `floor` node exists in the `openalea.math` package. The node `floor` is managed through a :class:`NodeFactory<openalea.core.node.NodeFactory>`.



.. topic:: Documentation status

.. sectionauthor:: Thomas Cokelaer <Thomas Cokelaer __at__ sophia inria fr>
Loading
Loading