From cca36a62d2eeb14964a9951c15939f3a5e8753d9 Mon Sep 17 00:00:00 2001 From: Filippo Luca Ferretti Date: Wed, 4 Oct 2023 15:39:59 +0200 Subject: [PATCH] Add sixd and utils modules --- docs/{source => }/conf.py | 4 ++-- docs/{source => }/index.rst | 0 docs/make.bat | 4 ++-- docs/modules/sixd.rst | 9 +++++++++ docs/modules/utils.rst | 9 +++++++++ 5 files changed, 22 insertions(+), 4 deletions(-) rename docs/{source => }/conf.py (86%) rename docs/{source => }/index.rst (100%) create mode 100644 docs/modules/sixd.rst create mode 100644 docs/modules/utils.rst diff --git a/docs/source/conf.py b/docs/conf.py similarity index 86% rename from docs/source/conf.py rename to docs/conf.py index 673bf9109..a73292e94 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -4,9 +4,9 @@ # -- Version information -sys.path.insert(0, pathlib.Path(__file__).parent.absolute()) +sys.path.insert(0, pathlib.Path(__file__).parents[2].absolute()) version_file = ( - pathlib.Path(__file__).parent.absolute() / "src" / "jaxsim" / "version.txt" + pathlib.Path(__file__).parents[2].absolute() / "src" / "jaxsim" / "version.txt" ) with open(version_file) as file_handler: diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/make.bat b/docs/make.bat index 6247f7e23..2119f5109 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source -set BUILDDIR=build +set SOURCEDIR=. +set BUILDDIR=_build if "%1" == "" goto help diff --git a/docs/modules/sixd.rst b/docs/modules/sixd.rst new file mode 100644 index 000000000..6b7afb12d --- /dev/null +++ b/docs/modules/sixd.rst @@ -0,0 +1,9 @@ +.. _sixd: + + +SixD +========== + +.. automodule:: jaxsim.sixd + :members: + \ No newline at end of file diff --git a/docs/modules/utils.rst b/docs/modules/utils.rst new file mode 100644 index 000000000..2abe3cbfa --- /dev/null +++ b/docs/modules/utils.rst @@ -0,0 +1,9 @@ +.. _utils: + + +Utils +========== + +.. automodule:: jaxsim.utils + :members: + \ No newline at end of file