-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝💡 Improves documentation and updates dependencies
Improvements: - Improves the documentation, source code comments and the README.md's. - Updates the dependencies that were defined in the setup.py and package.xml.
- Loading branch information
Showing
96 changed files
with
2,613 additions
and
758 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# 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 | ||
SPHINXPROJ = panda_openai_sim | ||
SOURCEDIR = source | ||
BUILDDIR = build | ||
GH_PAGES_SOURCES = docs panda_openai_sim nodes scripts | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Publish gh-pages command | ||
.PHONY: gh-pages | ||
gh-pages: | ||
cd .. && \ | ||
git submodule update --recursive && \ | ||
git checkout gh-pages && \ | ||
git rm -rf . && git clean -fxd && \ | ||
git checkout melodic-devel $(GH_PAGES_SOURCES) && \ | ||
git reset HEAD && \ | ||
cd docs && \ | ||
make clean && \ | ||
make html && \ | ||
cd .. && \ | ||
git add docs/build/html && \ | ||
git clean -ffxd && \ | ||
mv -fv docs/build/html/* ./ && \ | ||
touch .nojekyll && \ | ||
rm -rf $(GH_PAGES_SOURCES) && \ | ||
git add -A && \ | ||
git commit -m ":pencil: Generated gh-pages for `git log melodic-devel -1 --pretty=short --abbrev-commit`" && \ | ||
git push origin gh-pages && \ | ||
git checkout melodic-devel && \ | ||
git submodule update --recursive | ||
|
||
# Create make clean command | ||
.PHONY: clean | ||
clean: | ||
@rm -rf $(BUILDDIR)/* | ||
@echo "Build folder cleaned" | ||
|
||
# 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
||
if "%1" == "" goto help | ||
|
||
%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.http://sphinx-doc.org/ | ||
exit /b 1 | ||
) | ||
|
||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
goto end | ||
|
||
:help | ||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
|
||
:end | ||
popd |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
/* Css code that is used to overwrite parts of the RTD theme css*/ | ||
|
||
/* override table width restrictions */ | ||
@media screen and (min-width: 767px) { | ||
.wy-table-responsive table td { | ||
/* !important prevents the common CSS stylesheets from | ||
overriding this as on RTD they are loaded after this stylesheet */ | ||
white-space: normal !important; | ||
} | ||
.wy-table-responsive { | ||
overflow: visible !important; | ||
} | ||
} |
38 changes: 38 additions & 0 deletions
38
docs/source/api/_autosummary/morvan_ddpg_panda_train_and_inference.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
morvan\_ddpg\_panda\_train\_and\_inference | ||
========================================== | ||
|
||
.. automodule:: morvan_ddpg_panda_train_and_inference | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
.. rubric:: Functions | ||
|
||
.. autosummary:: | ||
|
||
eval | ||
train | ||
|
||
|
||
|
||
|
||
|
||
.. rubric:: Classes | ||
|
||
.. autosummary:: | ||
|
||
Actor | ||
Critic | ||
Memory | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
panda\_control\_server | ||
====================== | ||
|
||
.. automodule:: panda_control_server | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
panda\_moveit\_server | ||
===================== | ||
|
||
.. automodule:: panda_moveit_server | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
29 changes: 29 additions & 0 deletions
29
docs/source/api/_autosummary/panda_openai_sim.core.control_server.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
panda\_openai\_sim.core.control\_server | ||
======================================= | ||
|
||
.. automodule:: panda_openai_sim.core.control_server | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
.. rubric:: Classes | ||
|
||
.. autosummary:: | ||
|
||
PandaControlServer | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
30 changes: 30 additions & 0 deletions
30
docs/source/api/_autosummary/panda_openai_sim.core.control_switcher.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
panda\_openai\_sim.core.control\_switcher | ||
========================================= | ||
|
||
.. automodule:: panda_openai_sim.core.control_switcher | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
.. rubric:: Classes | ||
|
||
.. autosummary:: | ||
|
||
ControllerSwitcherResponse | ||
PandaControlSwitcher | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
29 changes: 29 additions & 0 deletions
29
docs/source/api/_autosummary/panda_openai_sim.core.group_publisher.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
panda\_openai\_sim.core.group\_publisher | ||
======================================== | ||
|
||
.. automodule:: panda_openai_sim.core.group_publisher | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
.. rubric:: Classes | ||
|
||
.. autosummary:: | ||
|
||
GroupPublisher | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Oops, something went wrong.