From a34ebf7f6fa95bf8f5f4b76a5267b807e8eacdb1 Mon Sep 17 00:00:00 2001
From: Tim Stadtmann <tim.stadtmann@rwth-aachen.de>
Date: Tue, 29 Nov 2016 15:47:45 +0100
Subject: [PATCH] Add MATLAB-params to doc config & adapt rst-files
---
docs/conf.py | 6 +++++-
docs/index.rst | 4 ++--
docs/source.rst | 27 +++++++++++++++++++--------
3 files changed, 26 insertions(+), 11 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index efb3fc2..137ea71 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -43,6 +43,10 @@ extensions = [
matlab_src_dir = os.path.abspath('..')
primary_domain = 'mat'
+#autoclass_content = 'init'
+#autodoc_member_order = 'groupwise'
+#autodoc_default_flags = ''
+
# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = False
@@ -106,7 +110,7 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '*hidapi*', '*.dll', '*.dylib', '*proto*', '*.h', '*.lib', '*.exp', 'ID.m', 'include', 'lib', 'private', '*.class', '*.java*', '*_*']
# The reST default role (used for this markup: `text`) to use for all
# documents.
diff --git a/docs/index.rst b/docs/index.rst
index 5211a72..6d136d5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to source's documentation!
-==================================
+EV3-Toolbox for controlling Lego Mindstorms EV3 with MATLAB
+===========================================================
Contents:
diff --git a/docs/source.rst b/docs/source.rst
index b72be03..f5b2873 100644
--- a/docs/source.rst
+++ b/docs/source.rst
@@ -1,10 +1,21 @@
-source package
-==============
+.. automodule:: source
-Module contents
----------------
+EV3
+---
-.. automodule:: source
- :members:
- :undoc-members:
- :show-inheritance:
+.. autoclass:: EV3
+ :members:
+
+
+Motor
+-----
+
+.. autoclass:: Motor
+ :members: start, stop, syncedStart, syncedStop, waitFor, internalReset, resetTachoCount, setBrake, setProperties
+
+
+Sensor
+------
+
+.. autoclass:: Sensor
+ :members: reset, setProperties
--
GitLab