Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
905e5dc
Remove the automock of Sofa
damienmarchal May 24, 2023
225a4c6
WIPPP
damienmarchal Jun 5, 2023
582ec1a
WIP
damienmarchal Jun 7, 2023
d21a12f
WIP2
damienmarchal Jun 7, 2023
bd12e8e
Remove sphinx-stubs as don't need them anymore.
damienmarchal Jun 7, 2023
0350f34
FIX Documentation
damienmarchal Jun 7, 2023
53aa155
W
damienmarchal Jun 7, 2023
3271198
WIP
damienmarchal Jun 7, 2023
5ff0262
WIP
damienmarchal Jun 7, 2023
2f25ac7
W
damienmarchal Jun 7, 2023
8b0a564
WIP
damienmarchal Jun 7, 2023
3f78144
W
damienmarchal Jun 7, 2023
5b38e02
W
damienmarchal Jun 7, 2023
0605073
W
damienmarchal Jun 7, 2023
34771db
W
damienmarchal Jun 8, 2023
43a29ae
W
damienmarchal Jun 8, 2023
8b6eb9d
W
damienmarchal Jun 8, 2023
2660fe1
D
damienmarchal Jun 8, 2023
75dae83
review and clean of documentation
hugtalbot Aug 29, 2023
ba0fbbc
Update requirements for automatization
hugtalbot Aug 29, 2023
194733c
Add action to generate doc on new release
hugtalbot Aug 29, 2023
0d58bdd
Up
damienmarchal Aug 30, 2023
d69e16f
Clean code, format and add full documentation
hugtalbot Aug 31, 2023
ebd0624
Merge branch 'master' into xp-readthedocs
hugtalbot Aug 31, 2023
36af3c5
Add as a trigger of action the edit of a release
hugtalbot Aug 31, 2023
0e28dc3
Merge branch 'master' into xp-readthedocs
hugtalbot Aug 31, 2023
a9ac53b
FIX
damienmarchal Aug 31, 2023
ca2ce2e
Merge remote-tracking branch 'origin/xp-readthedocs' into xp-readthedocs
damienmarchal Aug 31, 2023
da8fb59
Various documentation fixes.
damienmarchal Aug 31, 2023
4319f5c
Refactor the documentation organization & sections & subsection so th…
damienmarchal Sep 1, 2023
cc41156
Last improvements before upload
hugtalbot Sep 5, 2023
114ead7
Merge remote-tracking branch 'origin/master' into xp-readthedocs
damienmarchal Sep 13, 2024
acb13ef
We shouldent import scipy for our users. They are competent enough
damienmarchal Sep 13, 2024
8d82fba
FIX
damienmarchal Sep 13, 2024
c3dea64
D
damienmarchal Sep 13, 2024
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
Prev Previous commit
Next Next commit
FIX
  • Loading branch information
damienmarchal committed Aug 31, 2023
commit a9ac53beb8a600d187e0115a1d76d6583577d541
10 changes: 7 additions & 3 deletions bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base_doc.h
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,21 @@ static auto getLinkPath =
Returns the path name as a parsable string

.. code-block:: python
if object.getLinkName() is "/child1/object"
then the linkPath is @"/child1/object"

# returns is @"/child1/object" if getPathName() is @"/child1/object"
print(object.linkPath)

)";
static auto getPathName =
R"(
Returns the path name as a string

.. code-block:: python

a = Sofa.Core.Node("root")
b.addObject("Camera", name="camera")
b = a.addObject("Camera", name="camera")
b.getPathName() # should returns "/root/camera"

```
)";
static auto setDataValues =
Expand Down
12 changes: 7 additions & 5 deletions bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Node_doc.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ static auto Class =
of a same object can be done in different sub-nodes.

Example of use:
.. code-block:: python

.. code-block:: python

import Sofa.Core

Expand All @@ -54,7 +55,8 @@ static auto Class =
The child nodes, components and parents can be accessed using generator attributes.

Example of use:
.. code-block:: python

.. code-block:: python

# ...
n = Sofa.Core.Node("MyNode")
Expand All @@ -67,7 +69,9 @@ static auto Class =

Accessing children or object from the current node is easy thanks to the generalized access
API.

Example of use:

.. code-block:: python

# ...
Expand Down Expand Up @@ -174,9 +178,6 @@ static auto getObject =
The extra arguments allowed in the SofaPython (warning=True/False) binding are not supported SofaPython3.

.. code-block:: python
# SofaPython2:
if node.getObject("MyObject",warning=False):
pass

# SofaPython3:
if node.getObject("MyObject") != None:
Expand All @@ -187,6 +188,7 @@ static auto getObject =

if "MyObject" in node.objects:
pass

)";

static auto addChildKwargs =
Expand Down
7 changes: 5 additions & 2 deletions bindings/Sofa/src/SofaPython3/Sofa/Core/Submodule_Core.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ PYBIND11_MODULE(Core, core)
Node. Nodes are hierarchically organized in a scene graph.
For more, see the `SOFA lexicography <https://www.sofa-framework.org/community/doc/using-sofa/lexicography/>`_.
Commonly used classes:
.. autosummary::

.. autosummary::
:nosignatures:

Node
Expand All @@ -76,7 +77,8 @@ PYBIND11_MODULE(Core, core)

Example of use
--------------
.. code-block:: python

.. code-block:: python

import Sofa.Core

Expand All @@ -93,6 +95,7 @@ PYBIND11_MODULE(Core, core)

Sofa.Simulation.init(root)
Sofa.Simulation.print(root)

)doc";

moduleAddPythonScriptEvent();
Expand Down
5 changes: 0 additions & 5 deletions docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,6 @@
'sphinxcontrib.contentui',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
# 'sphinx_search.extension',
'sphinx.ext.autosectionlabel',
# 'sphinxcontrib.osexample'
]

import sys
Expand All @@ -58,8 +55,6 @@
autosummary_generate = True
autosummary_ignore_module_all = False

autosectionlabel_prefix_document=True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['templates']

Expand Down
2 changes: 2 additions & 0 deletions docs/sphinx/source/content/Compilation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ prerequisites.

.. _intree:

*************
In-tree build
*************

Expand Down Expand Up @@ -164,6 +165,7 @@ At this point, you are ready to start the compilation of SOFA and the SofaPython

.. _outtree:

*****************
Out-of-tree build
*****************

Expand Down