auto update doc

robotflow-initiative · Jan 29, 2024 · 296db1f · 296db1f
1 parent 0d58cf3
commit 296db1f
Show file tree

Hide file tree

Showing 115 changed files with 26,065 additions and 13,175 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -1,17 +1,11 @@
 # Sample workflow for building and deploying a Jekyll site to GitHub Pages
-name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+name: Deploy GitHub Pages
 
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
-    paths:
-      - 'docs/**'
-
-  pull_request:
-    branches: ["main"]
-    paths:
-      - 'docs/**'
+    tags:
+      - 'v*'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -34,12 +28,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install sphinx sphinx-rtd-theme myst-parser
+          curl -o Doc/markdown/get_started.md https://raw.githubusercontent.com/mvig-robotflow/rfuniverse/main/README.md
+          curl -o Doc/markdown/advanced_usages.md https://raw.githubusercontent.com/mvig-robotflow/rfuniverse/main/DevDoc.md
+          Doc/make.bat html
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
           name: github-pages
-          path: docs/
+          path: Doc/_build/html/
           retention-days: 1
       - name: Create tar.gz archive
         run: |

diff --git a/.gitignore b/.gitignore
@@ -11,5 +11,3 @@ pyrfuniverse.egg-info/
 Temp/
 
 dist/
-
-Doc/
diff --git a/.gitmodules b/.gitmodules
diff --git a/Doc/Makefile b/Doc/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     = .
+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/Doc/conf.py b/Doc/conf.py
@@ -0,0 +1,39 @@
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../'))
+
+# 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
+
+project = 'pyrfuniverse'
+copyright = '2023, RobotFlow'
+author = 'RobotFlow'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'myst_parser'
+]
+autodoc_member_order = 'bysource'
+
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+gettext_compact = True
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
diff --git a/..._sources/examples/camera_rendering.md.txt → Doc/examples/camera_rendering.md b/..._sources/examples/camera_rendering.md.txt → Doc/examples/camera_rendering.md
diff --git a/docs/_sources/examples/loading_urdf.md.txt → Doc/examples/loading_urdf.md b/docs/_sources/examples/loading_urdf.md.txt → Doc/examples/loading_urdf.md
diff --git a/docs/_sources/examples/pick_and_place.md.txt → Doc/examples/pick_and_place.md b/docs/_sources/examples/pick_and_place.md.txt → Doc/examples/pick_and_place.md
diff --git a/docs/_sources/examples/point_cloud.md.txt → Doc/examples/point_cloud.md b/docs/_sources/examples/point_cloud.md.txt → Doc/examples/point_cloud.md
diff --git a/..._sources/examples/scene_annotation.md.txt → Doc/examples/scene_annotation.md b/..._sources/examples/scene_annotation.md.txt → Doc/examples/scene_annotation.md
diff --git a/docs/_sources/examples/tobor_move.md.txt → Doc/examples/tobor_move.md b/docs/_sources/examples/tobor_move.md.txt → Doc/examples/tobor_move.md
diff --git a/docs/_sources/index.rst.txt → Doc/index.rst b/docs/_sources/index.rst.txt → Doc/index.rst
diff --git a/Doc/make.bat b/Doc/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+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/.../_sources/markdown/advanced_usages.md.txt → Doc/markdown/advanced_usages.md b/.../_sources/markdown/advanced_usages.md.txt → Doc/markdown/advanced_usages.md
diff --git a/docs/_sources/markdown/get_started.md.txt → Doc/markdown/get_started.md b/docs/_sources/markdown/get_started.md.txt → Doc/markdown/get_started.md
diff --git a/docs/_sources/markdown/introduction.md.txt → Doc/markdown/introduction.md b/docs/_sources/markdown/introduction.md.txt → Doc/markdown/introduction.md
diff --git a/docs/_images/logo.png → Doc/markdown/logo.png b/docs/_images/logo.png → Doc/markdown/logo.png
diff --git a/docs/_images/mermaid.png → Doc/markdown/mermaid.png b/docs/_images/mermaid.png → Doc/markdown/mermaid.png
diff --git a/...arkdown/understanding_pyrfuniverse.md.txt → Doc/markdown/understanding_pyrfuniverse.md b/...arkdown/understanding_pyrfuniverse.md.txt → Doc/markdown/understanding_pyrfuniverse.md
diff --git a/.../_sources/pyrfuniverse.attributes.rst.txt → Doc/pyrfuniverse.attributes.rst b/.../_sources/pyrfuniverse.attributes.rst.txt → Doc/pyrfuniverse.attributes.rst
@@ -4,14 +4,14 @@ pyrfuniverse.attributes package
 ===============================
 
 pyrfuniverse.attributes.base\_attr module
------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.base_attr
    :members:
    :show-inheritance:
 
 pyrfuniverse.attributes.camera\_attr module
--------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.camera_attr
    :members:
@@ -25,21 +25,21 @@ pyrfuniverse.attributes.cloth\_attr module
    :show-inheritance:
 
 pyrfuniverse.attributes.collider\_attr module
--------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.collider_attr
    :members:
    :show-inheritance:
 
 pyrfuniverse.attributes.controller\_attr module
----------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.controller_attr
    :members:
    :show-inheritance:
 
 pyrfuniverse.attributes.gameobject\_attr module
----------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.gameobject_attr
    :members:
@@ -53,14 +53,14 @@ pyrfuniverse.attributes.light\_attr module
    :show-inheritance:
 
 pyrfuniverse.attributes.pointcloud\_attr module
----------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.pointcloud_attr
    :members:
    :show-inheritance:
 
 pyrfuniverse.attributes.rigidbody\_attr module
---------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.attributes.rigidbody_attr
    :members:

diff --git a/docs/_sources/pyrfuniverse.envs.rst.txt → Doc/pyrfuniverse.envs.rst b/docs/_sources/pyrfuniverse.envs.rst.txt → Doc/pyrfuniverse.envs.rst
@@ -2,14 +2,14 @@ pyrfuniverse.envs package
 =========================
 
 pyrfuniverse.envs.base\_env module
---------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.envs.base_env
    :members:
    :show-inheritance:
 
 pyrfuniverse.envs.gym\_wrapper\_env module
---------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.envs.gym_wrapper_env
    :members:

diff --git a/docs/_sources/pyrfuniverse.utils.rst.txt → Doc/pyrfuniverse.utils.rst b/docs/_sources/pyrfuniverse.utils.rst.txt → Doc/pyrfuniverse.utils.rst
@@ -9,14 +9,14 @@ pyrfuniverse.utils.depth\_processor module
    :show-inheritance:
 
 pyrfuniverse.utils.rfuniverse\_utility module
--------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.utils.rfuniverse_utility
    :members:
    :show-inheritance:
 
 pyrfuniverse.utils.coordinate\_system\_converter module
--------------------------------------------------------------------------------
+----------------------------------------------------------------------------
 
 .. automodule:: pyrfuniverse.utils.coordinate_system_converter
    :members:

diff --git a/docs/_images/11.png → Doc/tutorials/cloth/1.png b/docs/_images/11.png → Doc/tutorials/cloth/1.png
diff --git a/Doc/tutorials/cloth/2.png b/Doc/tutorials/cloth/2.png
diff --git a/Doc/tutorials/cloth/3.png b/Doc/tutorials/cloth/3.png
diff --git a/Doc/tutorials/cloth/4.png b/Doc/tutorials/cloth/4.png
diff --git a/Doc/tutorials/cloth/5.png b/Doc/tutorials/cloth/5.png
diff --git a/docs/_images/tissue_catching_sim.png → Doc/tutorials/cloth/tissue_catching_sim.png b/docs/_images/tissue_catching_sim.png → Doc/tutorials/cloth/tissue_catching_sim.png
diff --git a/Doc/tutorials/cutting/1.PNG b/Doc/tutorials/cutting/1.PNG
diff --git a/Doc/tutorials/cutting/2.PNG b/Doc/tutorials/cutting/2.PNG
diff --git a/Doc/tutorials/cutting/3.PNG b/Doc/tutorials/cutting/3.PNG
diff --git a/Doc/tutorials/cutting/4.PNG b/Doc/tutorials/cutting/4.PNG
diff --git a/Doc/tutorials/cutting/5.PNG b/Doc/tutorials/cutting/5.PNG
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,5 +11,3 @@ pyrfuniverse.egg-info/
		Temp/

		dist/

		Doc/