From 1ae9d9f4bde242872944f88bf9aa67ae9d740f0c Mon Sep 17 00:00:00 2001 From: Ipuch Date: Tue, 23 May 2023 18:17:21 -0400 Subject: [PATCH 1/2] docs first attempt. --- bionc/__init__.py | 2 + docs/Makefile | 20 ++++ docs/bionc.bionc_casadi.rst | 125 +++++++++++++++++++++++++ docs/bionc.bionc_numpy.rst | 133 +++++++++++++++++++++++++++ docs/bionc.model_creation.rst | 85 +++++++++++++++++ docs/bionc.protocols.rst | 101 ++++++++++++++++++++ docs/bionc.rst | 23 +++++ docs/bionc.utils.rst | 21 +++++ docs/bionc.vizualization.rst | 21 +++++ docs/make.bat | 35 +++++++ docs/modules.rst | 7 ++ docs/source/bionc.bionc_casadi.rst | 125 +++++++++++++++++++++++++ docs/source/bionc.bionc_numpy.rst | 133 +++++++++++++++++++++++++++ docs/source/bionc.model_creation.rst | 85 +++++++++++++++++ docs/source/bionc.protocols.rst | 101 ++++++++++++++++++++ docs/source/bionc.rst | 23 +++++ docs/source/bionc.utils.rst | 21 +++++ docs/source/bionc.vizualization.rst | 21 +++++ docs/source/conf.py | 49 ++++++++++ docs/source/index.rst | 20 ++++ docs/source/modules.rst | 7 ++ 21 files changed, 1158 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/bionc.bionc_casadi.rst create mode 100644 docs/bionc.bionc_numpy.rst create mode 100644 docs/bionc.model_creation.rst create mode 100644 docs/bionc.protocols.rst create mode 100644 docs/bionc.rst create mode 100644 docs/bionc.utils.rst create mode 100644 docs/bionc.vizualization.rst create mode 100644 docs/make.bat create mode 100644 docs/modules.rst create mode 100644 docs/source/bionc.bionc_casadi.rst create mode 100644 docs/source/bionc.bionc_numpy.rst create mode 100644 docs/source/bionc.model_creation.rst create mode 100644 docs/source/bionc.protocols.rst create mode 100644 docs/source/bionc.rst create mode 100644 docs/source/bionc.utils.rst create mode 100644 docs/source/bionc.vizualization.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/modules.rst diff --git a/bionc/__init__.py b/bionc/__init__.py index 3413c288..46d32a92 100644 --- a/bionc/__init__.py +++ b/bionc/__init__.py @@ -42,3 +42,5 @@ from .vizualization import Viz from .bionc_numpy import InverseKinematics + +__version__= "0.5.0" diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d0c3cbf1 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/bionc.bionc_casadi.rst b/docs/bionc.bionc_casadi.rst new file mode 100644 index 00000000..fa43b0ff --- /dev/null +++ b/docs/bionc.bionc_casadi.rst @@ -0,0 +1,125 @@ +bionc.bionc\_casadi package +=========================== + +Submodules +---------- + +bionc.bionc\_casadi.biomechanical\_model module +----------------------------------------------- + +.. automodule:: bionc.bionc_casadi.biomechanical_model + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.cartesian\_vector module +-------------------------------------------- + +.. automodule:: bionc.bionc_casadi.cartesian_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.external\_force module +------------------------------------------ + +.. automodule:: bionc.bionc_casadi.external_force + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.homogenous\_transform module +------------------------------------------------ + +.. automodule:: bionc.bionc_casadi.homogenous_transform + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.inertia\_parameters module +---------------------------------------------- + +.. automodule:: bionc.bionc_casadi.inertia_parameters + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.joint module +-------------------------------- + +.. automodule:: bionc.bionc_casadi.joint + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_accelerations module +------------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_accelerations + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_axis module +---------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_axis + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_coordinates module +----------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_coordinates + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_marker module +------------------------------------------ + +.. automodule:: bionc.bionc_casadi.natural_marker + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_segment module +------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_segment + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_vector module +------------------------------------------ + +.. automodule:: bionc.bionc_casadi.natural_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_velocities module +---------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_velocities + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.utils module +-------------------------------- + +.. automodule:: bionc.bionc_casadi.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.bionc_casadi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/bionc.bionc_numpy.rst b/docs/bionc.bionc_numpy.rst new file mode 100644 index 00000000..6f4df46c --- /dev/null +++ b/docs/bionc.bionc_numpy.rst @@ -0,0 +1,133 @@ +bionc.bionc\_numpy package +========================== + +Submodules +---------- + +bionc.bionc\_numpy.biomechanical\_model module +---------------------------------------------- + +.. automodule:: bionc.bionc_numpy.biomechanical_model + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.cartesian\_vector module +------------------------------------------- + +.. automodule:: bionc.bionc_numpy.cartesian_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.enums module +------------------------------- + +.. automodule:: bionc.bionc_numpy.enums + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.external\_force module +----------------------------------------- + +.. automodule:: bionc.bionc_numpy.external_force + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.homogenous\_transform module +----------------------------------------------- + +.. automodule:: bionc.bionc_numpy.homogenous_transform + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.inertia\_parameters module +--------------------------------------------- + +.. automodule:: bionc.bionc_numpy.inertia_parameters + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.inverse\_kinematics module +--------------------------------------------- + +.. automodule:: bionc.bionc_numpy.inverse_kinematics + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.joint module +------------------------------- + +.. automodule:: bionc.bionc_numpy.joint + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_accelerations module +------------------------------------------------ + +.. automodule:: bionc.bionc_numpy.natural_accelerations + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_axis module +--------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_axis + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_coordinates module +---------------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_coordinates + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_marker module +----------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_marker + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_segment module +------------------------------------------ + +.. automodule:: bionc.bionc_numpy.natural_segment + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_vector module +----------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_velocities module +--------------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_velocities + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.bionc_numpy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/bionc.model_creation.rst b/docs/bionc.model_creation.rst new file mode 100644 index 00000000..a153781e --- /dev/null +++ b/docs/bionc.model_creation.rst @@ -0,0 +1,85 @@ +bionc.model\_creation package +============================= + +Submodules +---------- + +bionc.model\_creation.biomechanical\_model\_template module +----------------------------------------------------------- + +.. automodule:: bionc.model_creation.biomechanical_model_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.c3d\_data module +-------------------------------------- + +.. automodule:: bionc.model_creation.c3d_data + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.generic\_data module +------------------------------------------ + +.. automodule:: bionc.model_creation.generic_data + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.inertia\_parameters\_template module +---------------------------------------------------------- + +.. automodule:: bionc.model_creation.inertia_parameters_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.marker\_template module +--------------------------------------------- + +.. automodule:: bionc.model_creation.marker_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.natural\_axis\_template module +---------------------------------------------------- + +.. automodule:: bionc.model_creation.natural_axis_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.natural\_segment\_template module +------------------------------------------------------- + +.. automodule:: bionc.model_creation.natural_segment_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.protocols module +-------------------------------------- + +.. automodule:: bionc.model_creation.protocols + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.segment\_template module +---------------------------------------------- + +.. automodule:: bionc.model_creation.segment_template + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.model_creation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/bionc.protocols.rst b/docs/bionc.protocols.rst new file mode 100644 index 00000000..5e8518bf --- /dev/null +++ b/docs/bionc.protocols.rst @@ -0,0 +1,101 @@ +bionc.protocols package +======================= + +Submodules +---------- + +bionc.protocols.biomechanical\_model module +------------------------------------------- + +.. automodule:: bionc.protocols.biomechanical_model + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.external\_force module +-------------------------------------- + +.. automodule:: bionc.protocols.external_force + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.homogenous\_transform module +-------------------------------------------- + +.. automodule:: bionc.protocols.homogenous_transform + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.interpolation\_matrix module +-------------------------------------------- + +.. automodule:: bionc.protocols.interpolation_matrix + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.joint module +---------------------------- + +.. automodule:: bionc.protocols.joint + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_accelerations module +--------------------------------------------- + +.. automodule:: bionc.protocols.natural_accelerations + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_coordinates module +------------------------------------------- + +.. automodule:: bionc.protocols.natural_coordinates + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_markers module +--------------------------------------- + +.. automodule:: bionc.protocols.natural_markers + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_segment module +--------------------------------------- + +.. automodule:: bionc.protocols.natural_segment + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_vector module +-------------------------------------- + +.. automodule:: bionc.protocols.natural_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_velocities module +------------------------------------------ + +.. automodule:: bionc.protocols.natural_velocities + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.protocols + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/bionc.rst b/docs/bionc.rst new file mode 100644 index 00000000..95e2a55d --- /dev/null +++ b/docs/bionc.rst @@ -0,0 +1,23 @@ +bionc package +============= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + bionc.bionc_casadi + bionc.bionc_numpy + bionc.model_creation + bionc.protocols + bionc.utils + bionc.vizualization + +Module contents +--------------- + +.. automodule:: bionc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/bionc.utils.rst b/docs/bionc.utils.rst new file mode 100644 index 00000000..dce943a4 --- /dev/null +++ b/docs/bionc.utils.rst @@ -0,0 +1,21 @@ +bionc.utils package +=================== + +Submodules +---------- + +bionc.utils.enums module +------------------------ + +.. automodule:: bionc.utils.enums + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/bionc.vizualization.rst b/docs/bionc.vizualization.rst new file mode 100644 index 00000000..bf8c026f --- /dev/null +++ b/docs/bionc.vizualization.rst @@ -0,0 +1,21 @@ +bionc.vizualization package +=========================== + +Submodules +---------- + +bionc.vizualization.animations module +------------------------------------- + +.. automodule:: bionc.vizualization.animations + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.vizualization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..747ffb7b --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 00000000..3f30e40b --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +bionc +===== + +.. toctree:: + :maxdepth: 4 + + bionc diff --git a/docs/source/bionc.bionc_casadi.rst b/docs/source/bionc.bionc_casadi.rst new file mode 100644 index 00000000..fa43b0ff --- /dev/null +++ b/docs/source/bionc.bionc_casadi.rst @@ -0,0 +1,125 @@ +bionc.bionc\_casadi package +=========================== + +Submodules +---------- + +bionc.bionc\_casadi.biomechanical\_model module +----------------------------------------------- + +.. automodule:: bionc.bionc_casadi.biomechanical_model + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.cartesian\_vector module +-------------------------------------------- + +.. automodule:: bionc.bionc_casadi.cartesian_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.external\_force module +------------------------------------------ + +.. automodule:: bionc.bionc_casadi.external_force + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.homogenous\_transform module +------------------------------------------------ + +.. automodule:: bionc.bionc_casadi.homogenous_transform + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.inertia\_parameters module +---------------------------------------------- + +.. automodule:: bionc.bionc_casadi.inertia_parameters + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.joint module +-------------------------------- + +.. automodule:: bionc.bionc_casadi.joint + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_accelerations module +------------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_accelerations + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_axis module +---------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_axis + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_coordinates module +----------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_coordinates + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_marker module +------------------------------------------ + +.. automodule:: bionc.bionc_casadi.natural_marker + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_segment module +------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_segment + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_vector module +------------------------------------------ + +.. automodule:: bionc.bionc_casadi.natural_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.natural\_velocities module +---------------------------------------------- + +.. automodule:: bionc.bionc_casadi.natural_velocities + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_casadi.utils module +-------------------------------- + +.. automodule:: bionc.bionc_casadi.utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.bionc_casadi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bionc.bionc_numpy.rst b/docs/source/bionc.bionc_numpy.rst new file mode 100644 index 00000000..6f4df46c --- /dev/null +++ b/docs/source/bionc.bionc_numpy.rst @@ -0,0 +1,133 @@ +bionc.bionc\_numpy package +========================== + +Submodules +---------- + +bionc.bionc\_numpy.biomechanical\_model module +---------------------------------------------- + +.. automodule:: bionc.bionc_numpy.biomechanical_model + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.cartesian\_vector module +------------------------------------------- + +.. automodule:: bionc.bionc_numpy.cartesian_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.enums module +------------------------------- + +.. automodule:: bionc.bionc_numpy.enums + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.external\_force module +----------------------------------------- + +.. automodule:: bionc.bionc_numpy.external_force + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.homogenous\_transform module +----------------------------------------------- + +.. automodule:: bionc.bionc_numpy.homogenous_transform + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.inertia\_parameters module +--------------------------------------------- + +.. automodule:: bionc.bionc_numpy.inertia_parameters + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.inverse\_kinematics module +--------------------------------------------- + +.. automodule:: bionc.bionc_numpy.inverse_kinematics + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.joint module +------------------------------- + +.. automodule:: bionc.bionc_numpy.joint + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_accelerations module +------------------------------------------------ + +.. automodule:: bionc.bionc_numpy.natural_accelerations + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_axis module +--------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_axis + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_coordinates module +---------------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_coordinates + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_marker module +----------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_marker + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_segment module +------------------------------------------ + +.. automodule:: bionc.bionc_numpy.natural_segment + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_vector module +----------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.bionc\_numpy.natural\_velocities module +--------------------------------------------- + +.. automodule:: bionc.bionc_numpy.natural_velocities + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.bionc_numpy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bionc.model_creation.rst b/docs/source/bionc.model_creation.rst new file mode 100644 index 00000000..a153781e --- /dev/null +++ b/docs/source/bionc.model_creation.rst @@ -0,0 +1,85 @@ +bionc.model\_creation package +============================= + +Submodules +---------- + +bionc.model\_creation.biomechanical\_model\_template module +----------------------------------------------------------- + +.. automodule:: bionc.model_creation.biomechanical_model_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.c3d\_data module +-------------------------------------- + +.. automodule:: bionc.model_creation.c3d_data + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.generic\_data module +------------------------------------------ + +.. automodule:: bionc.model_creation.generic_data + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.inertia\_parameters\_template module +---------------------------------------------------------- + +.. automodule:: bionc.model_creation.inertia_parameters_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.marker\_template module +--------------------------------------------- + +.. automodule:: bionc.model_creation.marker_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.natural\_axis\_template module +---------------------------------------------------- + +.. automodule:: bionc.model_creation.natural_axis_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.natural\_segment\_template module +------------------------------------------------------- + +.. automodule:: bionc.model_creation.natural_segment_template + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.protocols module +-------------------------------------- + +.. automodule:: bionc.model_creation.protocols + :members: + :undoc-members: + :show-inheritance: + +bionc.model\_creation.segment\_template module +---------------------------------------------- + +.. automodule:: bionc.model_creation.segment_template + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.model_creation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bionc.protocols.rst b/docs/source/bionc.protocols.rst new file mode 100644 index 00000000..5e8518bf --- /dev/null +++ b/docs/source/bionc.protocols.rst @@ -0,0 +1,101 @@ +bionc.protocols package +======================= + +Submodules +---------- + +bionc.protocols.biomechanical\_model module +------------------------------------------- + +.. automodule:: bionc.protocols.biomechanical_model + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.external\_force module +-------------------------------------- + +.. automodule:: bionc.protocols.external_force + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.homogenous\_transform module +-------------------------------------------- + +.. automodule:: bionc.protocols.homogenous_transform + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.interpolation\_matrix module +-------------------------------------------- + +.. automodule:: bionc.protocols.interpolation_matrix + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.joint module +---------------------------- + +.. automodule:: bionc.protocols.joint + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_accelerations module +--------------------------------------------- + +.. automodule:: bionc.protocols.natural_accelerations + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_coordinates module +------------------------------------------- + +.. automodule:: bionc.protocols.natural_coordinates + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_markers module +--------------------------------------- + +.. automodule:: bionc.protocols.natural_markers + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_segment module +--------------------------------------- + +.. automodule:: bionc.protocols.natural_segment + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_vector module +-------------------------------------- + +.. automodule:: bionc.protocols.natural_vector + :members: + :undoc-members: + :show-inheritance: + +bionc.protocols.natural\_velocities module +------------------------------------------ + +.. automodule:: bionc.protocols.natural_velocities + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.protocols + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bionc.rst b/docs/source/bionc.rst new file mode 100644 index 00000000..95e2a55d --- /dev/null +++ b/docs/source/bionc.rst @@ -0,0 +1,23 @@ +bionc package +============= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + bionc.bionc_casadi + bionc.bionc_numpy + bionc.model_creation + bionc.protocols + bionc.utils + bionc.vizualization + +Module contents +--------------- + +.. automodule:: bionc + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bionc.utils.rst b/docs/source/bionc.utils.rst new file mode 100644 index 00000000..dce943a4 --- /dev/null +++ b/docs/source/bionc.utils.rst @@ -0,0 +1,21 @@ +bionc.utils package +=================== + +Submodules +---------- + +bionc.utils.enums module +------------------------ + +.. automodule:: bionc.utils.enums + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/bionc.vizualization.rst b/docs/source/bionc.vizualization.rst new file mode 100644 index 00000000..bf8c026f --- /dev/null +++ b/docs/source/bionc.vizualization.rst @@ -0,0 +1,21 @@ +bionc.vizualization package +=========================== + +Submodules +---------- + +bionc.vizualization.animations module +------------------------------------- + +.. automodule:: bionc.vizualization.animations + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: bionc.vizualization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..2fd289f3 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,49 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +import os +import sys + +sys.path.insert(0, os.path.abspath("../../")) + +# print(sys.path.insert(0, os.path.abspath("../../"))) +# print("Hello world") + +project = 'bionc' +copyright = '2023, Pierre Puchaud' +author = 'Pierre Puchaud' +release = '0.5.0' + +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "sphinx.ext.napoleon", + "myst_parser", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "sphinx_rtd_theme" +html_static_path = ["_static"] + +source_suffix = { + ".rst": "restructuredtext", + ".txt": "markdown", + ".md": "markdown", +} diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..6d7eb1a4 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. bionc documentation master file, created by + sphinx-quickstart on Tue May 23 17:52:07 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to bionc's documentation! +================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 00000000..3f30e40b --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +bionc +===== + +.. toctree:: + :maxdepth: 4 + + bionc From 399a9f1d917e58f64cf8be8f596a0f9712382c3d Mon Sep 17 00:00:00 2001 From: Ipuch Date: Tue, 30 May 2023 20:37:27 -0400 Subject: [PATCH 2/2] black --- bionc/__init__.py | 2 +- docs/source/conf.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/bionc/__init__.py b/bionc/__init__.py index 46d32a92..beefec63 100644 --- a/bionc/__init__.py +++ b/bionc/__init__.py @@ -43,4 +43,4 @@ from .vizualization import Viz from .bionc_numpy import InverseKinematics -__version__= "0.5.0" +__version__ = "0.5.0" diff --git a/docs/source/conf.py b/docs/source/conf.py index 2fd289f3..7c2c6be5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -14,10 +14,10 @@ # print(sys.path.insert(0, os.path.abspath("../../"))) # print("Hello world") -project = 'bionc' -copyright = '2023, Pierre Puchaud' -author = 'Pierre Puchaud' -release = '0.5.0' +project = "bionc" +copyright = "2023, Pierre Puchaud" +author = "Pierre Puchaud" +release = "0.5.0" # ones. extensions = [