Merge branch 'fix/docs_generation' into 'develop'

fix: API generation

See merge request dev/sys/tci/rafcon!28

.gitlab-ci.yml

@@ -33,14 +33,14 @@ docs_test:
   variables:
     BUILD_DIR: build
     CONAN_OPTIONS: ""
-    MAKE_CMD_DOCS: "sphinx-build -b html doc build/docs/html"
+    MAKE_CMD_DOCS: "make docs"
 
 pages:
   extends: .docs_pages
   variables:
     BUILD_DIR: build
     CONAN_OPTIONS: ""
-    MAKE_CMD_DOCS: "sphinx-build -b html doc build/docs/html"
+    MAKE_CMD_DOCS: "make docs"
   except:
     variables:
       - $AR_CI_DOCS_DISABLE == "true"

CHANGELOG.rst

@@ -143,7 +143,7 @@ Maintenance release.
 
 - Improvements:
 
-  - most ``[PyGTK]DeprecatedWarning``s are fixed
+  - most ``[PyGTK]DeprecatedWarning``\s are fixed
   - graphical editor: minor performance optimizations
   - specify separators for JSON files: Python 3.4 no longer changes the whitespaces in state machine files
   - override builtins string in JSON files: state machine files generated by Python 2 and 3 are now fully identical
@@ -155,7 +155,7 @@ Maintenance release.
   - better defaults:
 
     - root state is named "root state", further states "[state type] [states counter]"
-    - script of ``ExecutionState``s uses more RAFCON features (``preemptive_wait``, return outcome name)
+    - script of ``ExecutionState``\s uses more RAFCON features (``preemptive_wait``, return outcome name)
     - name of states uses full width of state
 
   - provide RAFCON wheel file
@@ -266,8 +266,7 @@ Patch releases 0.13.\*
 
   - :issue_ghe:`678` script validation does not work
   - :issue_ghe:`663` cannot rename connected data port of type object
-  - :issue_ghe:`684` ``test_simple_execution_model_and_core_destruct_with_gui`` fails when running core & gui tests
-  in a row
+  - :issue_ghe:`684` ``test_simple_execution_model_and_core_destruct_with_gui`` fails when running core & gui tests in a row
   - fix pause and step mode behavior
   - installation of fonts under Python 3
   - various test fixed for Python 3

Makefile

@@ -0,0 +1,27 @@
+.PHONY: all docs build clean help
+
+
+all: docs
+
+
+# generate build folders
+build:
+	mkdir -p build/docs
+
+docs: build
+	echo "$(dirname "$1")"
+	pip3 install virtualenv || return -1
+	python3 -m virtualenv venv --system-site-packages || return -1
+	# Don't use the source command since not all shells support it.
+	. venv/bin/activate;\
+	pip3 install -r requirements-py3.txt;\
+	sphinx-build -v -b html doc build/docs/html
+
+clean:
+	rm -rf build
+	rm -rf venv
+
+help:
+	@echo "Available Targets:"
+	@echo "... all"
+	@echo "... docs"

doc/api/rafcon.core.rst

@@ -17,43 +17,87 @@ Subpackages
 config
 ------
 .. automodule:: rafcon.core.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 custom_exceptions
 -----------------
 .. automodule:: rafcon.core.custom_exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 constants (in rafcon.core)
 --------------------------
 .. automodule:: rafcon.core.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 global_variable_manager
 -----------------------
 .. automodule:: rafcon.core.global_variable_manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 id_generator
 ------------
 .. automodule:: rafcon.core.id_generator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 interface
 ---------
 .. automodule:: rafcon.core.interface
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 library_manager
 ---------------
 .. automodule:: rafcon.core.library_manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 script
 ------
 .. automodule:: rafcon.core.script
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 singleton (in rafcon.core)
 --------------------------
 .. automodule:: rafcon.core.singleton
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 state_machine
 -------------
 .. automodule:: rafcon.core.state_machine
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 state_machine_manager
 ---------------------
 .. automodule:: rafcon.core.state_machine_manager
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/api/rafcon.core.state_elements.rst

@@ -7,23 +7,47 @@ StateElements: ``state_elements``
 DataFlow
 --------
 .. automodule:: rafcon.core.state_elements.data_flow
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-Data Ports
+
+DataPorts
 ----------
 .. automodule:: rafcon.core.state_elements.data_port
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 Logical Ports
 -------------
 .. automodule:: rafcon.core.state_elements.logical_port
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
-Scope
------
+Scope (State Element)
+---------------------
 .. automodule:: rafcon.core.state_elements.scope
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 Transition
 ----------
 .. automodule:: rafcon.core.state_elements.transition
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 StateElement
 ------------
 .. automodule:: rafcon.core.state_elements.state_element
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

doc/api/rafcon.core.states.rst

@@ -7,31 +7,57 @@ States: ``states``
 barrier_concurrency
 -------------------
 .. automodule:: rafcon.core.states.barrier_concurrency_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 concurrency_state
 -----------------
 .. automodule:: rafcon.core.states.concurrency_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 
 container_state
 ---------------
 .. automodule:: rafcon.core.states.container_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 execution_state
 ---------------
 .. automodule:: rafcon.core.states.execution_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 hierarchy_state
 ---------------
 .. automodule:: rafcon.core.states.hierarchy_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 library_state
 -------------
 .. automodule:: rafcon.core.states.library_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 preemptive_concurrency
 ----------------------
 .. automodule:: rafcon.core.states.preemptive_concurrency_state
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 state
 -----
 .. automodule:: rafcon.core.states.state
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/rafcon.core.storage.rst

@@ -7,3 +7,6 @@ storage (in rafcon.core.storage)
 Helper functions to store a statemachine in the local file system and load it from there
 
 .. automodule:: rafcon.core.storage.storage
+    :members:
+    :undoc-members:
+    :show-inheritance: