Updated version of documentation (#449)

* Remove the automock of Sofa

* WIPPP

* WIP

* WIP2

* Remove sphinx-stubs as don't need them anymore.

* FIX Documentation

* W

* WIP

* WIP

* W

* WIP

* W

* W

* W

* W

* W

* W

* D

* review and clean of documentation

* Update requirements for automatization

* Add action to generate doc on new release

* Up

* Clean code, format and add full documentation

* Add as a trigger of action the edit of a release

* FIX

* Various documentation fixes.

* Refactor the documentation organization & sections & subsection so the menu looks ok

* Last improvements before upload

* We shouldent import scipy for our users. They are competent enough

* FIX

* Fix broken tests.

* Remove an introduced change in SofaRuntime.

* Update .github/workflows/build_docs.yml

Co-authored-by: Hugo <[email protected]>

* Update CMakeLists.txt

Co-authored-by: Hugo <[email protected]>

* Delete .github/workflows/build_docs.yml

---------

Co-authored-by: Hugo Talbot <[email protected]>

Author: damienmarchal

.gitignore

@@ -5,6 +5,7 @@
 __pycache__/
 *.pyc
 *.so
-docs/stubs
-docs/sphinx/build/
-docs/sphinx/source/*/_autosummary*
+docs/sphinx/build/*
+docs/sphinx/source/*/generated
+docs/sphinx/source/*/*/generated
+docs/sphinx/source/*/*/*/generated

.readthedocs.yml

@@ -9,16 +9,10 @@ version: 2
 sphinx:
   configuration: docs/sphinx/source/conf.py
 
-# Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
-
-# Optionally build your docs in additional formats such as PDF
-formats:
-  - pdf
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  version: 3.7
-  install:
-    - requirements: docs/sphinx/source/requirements.txt
+build:
+  os: "ubuntu-22.04"
+  commands:
+    - mkdir --parents $READTHEDOCS_OUTPUT/html/
+    - wget https://github.com/sofa-framework/SofaPython3/releases/download/release-v23.06/SofaPython3_v23.06_docs.zip
+    - unzip SofaPython3_v23.06_docs.zip
+    - cp --recursive build/html/* $READTHEDOCS_OUTPUT/html/

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.12)
 
-project(SofaPython3 VERSION 20.12.00)
+project(SofaPython3 VERSION 24.12.99)
 
 find_package(Sofa.Config REQUIRED)
 

Plugin/src/SofaPython3/Prefab.cpp

@@ -68,7 +68,6 @@ void Prefab::reinit()
 
     doReInit();
 
-    /// Beurk beurk beurk
     sofa::simulation::node::init(this);
     execute<VisualInitVisitor>(sofa::core::visual::visualparams::defaultInstance());
 }

bindings/Modules/src/SofaPython3/SofaBaseTopology/Module_SofaBaseTopology.cpp

@@ -32,10 +32,12 @@ namespace sofapython3
 
 PYBIND11_MODULE(SofaBaseTopology, m)
 {
+    m.doc() = "Implements some topology component (Regular and SparseGridTopology)";
+
     sofa::component::topology::container::grid::init();
 
     moduleAddRegularGridTopology(m);
     moduleAddSparseGridTopology(m);
 }
 
-} // namespace sofapython3
+} // namespace sofapython3

bindings/Modules/src/SofaPython3/SofaConstraintSolver/Module_SofaConstraintSolver.cpp

@@ -26,6 +26,8 @@ namespace sofapython3
 
 PYBIND11_MODULE(SofaConstraintSolver, m)
 {
+    m.doc() = "Implements the solver for constraint problems";
+
     moduleAddConstraintSolver(m);
 }
 

bindings/Modules/src/SofaPython3/SofaDeformable/Binding_LinearSpring_doc.h

@@ -24,12 +24,13 @@ namespace sofapython3::doc::SofaDeformable {
 
 static auto LinearSpringClass =
 R"(
-A LinearSpring between two objects, specified by indices on a topology.
+A linear spring connecting pair of nodes of two different objects
 )";
 
 static auto LinearSpringInit =
 R"(
 Create a linear spring from indices and spring parameters.
+
 :param index1: Index of the point on object 1.
 :param index2: Index of the point on object 2.
 :param springStiffness: Stiffnes k of the spring (f = -k*x -d*v)
@@ -39,6 +40,7 @@ Create a linear spring from indices and spring parameters.
 :param enabled: If set to false, no force will be calculated for this spring
 
 :return: A linear spring of type Sofa.SofaDeformable.LinearSpring
+
 )";
 
 } // sofapython3::doc::SofaDeformable

bindings/Modules/src/SofaPython3/SofaDeformable/Binding_SpringForceField.cpp

@@ -47,7 +47,9 @@ void bindSpringForcefield(py::module& m) {
 
     // create a python binding for the c++ class SpringForceField from SofaDeformable
     // no init binding, because creation should be done via node.addObject("SpringForceField")
-    std::string type_name = sofa::helper::NameDecoder::getTypeName<SpringForceField>();
+    std::string type_name = SpringForceField::GetClass()->className+"_"+
+                            DataType::Name();
+
     py::class_<SpringForceField,
             sofa::core::objectmodel::BaseObject,
             py_shared_ptr<SpringForceField>> s (m, type_name.c_str(), sofapython3::doc::SofaDeformable::SpringForceFieldClass);

bindings/Modules/src/SofaPython3/SofaDeformable/Module_SofaDeformable.cpp

@@ -30,6 +30,8 @@ namespace sofapython3
 
 PYBIND11_MODULE(SofaDeformable, m)
 {
+    m.doc() = "Implements linear springs between objects";
+
     moduleAddLinearSpring(m);
     moduleAddSpringForceField(m);
 }

bindings/Modules/src/SofaPython3/SofaGL/Module_SofaGL.cpp

@@ -29,6 +29,8 @@ namespace sofapython3
 
 PYBIND11_MODULE(SofaGL, m)
 {
+    m.doc() = "Exposes the rendering API using OpenGL";
+
     moduleAddDrawToolGL(m);
 }