Skip to content

Commit

Permalink
📝💡 Improves documentation and updates dependencies
Browse files Browse the repository at this point in the history
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
rickstaa committed Jun 10, 2020
1 parent eb11aae commit c33ca1b
Show file tree
Hide file tree
Showing 96 changed files with 2,613 additions and 758 deletions.
118 changes: 0 additions & 118 deletions README_old.md

This file was deleted.

52 changes: 52 additions & 0 deletions docs/Makefile
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)
35 changes: 35 additions & 0 deletions docs/make.bat
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 removed docs/manuals/Franka_manual.pdf
Binary file not shown.
13 changes: 13 additions & 0 deletions docs/source/_static/theme_overrides.css
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;
}
}
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









23 changes: 23 additions & 0 deletions docs/source/api/_autosummary/panda_control_server.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
panda\_control\_server
======================

.. automodule:: panda_control_server



















23 changes: 23 additions & 0 deletions docs/source/api/_autosummary/panda_moveit_server.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
panda\_moveit\_server
=====================

.. automodule:: panda_moveit_server



















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









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









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









Loading

0 comments on commit c33ca1b

Please sign in to comment.