document siconos.mechanics interface

[xhub]

There are many examples in examples/Mechanics/ContactDetection/BulletIO that could be interesting to put in the documentation (and it would be good also to document how the simulation in running in those)

[vacary]

I am working on the code right now. I will discuss with @bremond to add some doc and to improve naming

[bremond]

We dot not have any conventions for docstrings. The main problem is
how to document some function, method or class parameters

I propose we use

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

it is sphinx compatible and human readable.

[fperignon]

Le 4 janv. 2017 à 14:46, bremond ***@***.***> a écrit : We dot not have any conventions for docstrings. The main problem is how to document some function, method or class parameters I propose we use https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>

yes! And it might be useful (necessary?) to activate numpydoc in siconos/Docs/sphinx//conf.py.in (It was done but commented since it adds a new package dep. for siconos, numpydoc)

it is sphinx compatible and human readable. The documentation of parameters is then: Parameters x : type Description of parameter x. y Description of parameter y (with type not specified) I found this much more readable than the sphinx apidoc format: :param arg1: description :param arg2: description :type arg1: type description :type arg1: type description —

agree, but mind the spaces and tabs when writing documentation with numpydoc Parameters - - - - - - - - - (underline req) name : type TAB description and type can be something like :class:`siconos.kernel.someclass_name` leading to a proper link to someclass_name in the doc or even C++ class from doxygen, with type == :doxysiconos:`SomeC++ClassName` or :doxysiconos:`SomeFunctionName()` You can find examples in Docs/sphinx/users_guide/osns_problems.rst

…

You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#25 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHbsU0CBWmJ2L1fxvHM-72Ui9tvDy05Oks5rO6LIgaJpZM4HvnNS>.

[xhub]

LGTM. Closing?

[vacary]

Lesbian Gay Transexual Movement = LGTM ?

[bremond]

well, we are ok on numpy conventions but the documentation is not done... I have just add some empty rst files with api automodule for bodies, joints, tools. Some points: - we must have some usage with examples as it is done for numerics and kernel - io and mechanics_io are not yet there - the rendering in sphinx from doxygen is still very bad as it is for other modules (kernel, numerics)

[xhub]

Lesbian Gay Transexual Movement = LGTM ?

Looks Good To Me

[xhub]

Any updates?