update doc

- add properties, parameters and commands to the doc string autoatically
- change names to "Frappy"
- started tutorial
- changed doc structure slightly

Change-Id: I87bef91384d138c738d12ddcf3a1de7f758a0973

doc/source/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# SECoP documentation build configuration file, created by
+# Frappy documentation build configuration file, created by
 # sphinx-quickstart on Mon Sep 11 10:58:28 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -57,9 +57,9 @@ source_suffix = ['.rst', '.md']
 master_doc = 'index'
 
 # General information about the project.
-project = 'SECoP'
-#copyright = '2017, Enrico Faulhaber, Markus Zolliker'
-copyright = '2017, SECoP Committee'
+project = 'Frappy'
+copyright = '2017-2021, Enrico Faulhaber, Markus Zolliker,'
+#copyright = '2017, SECoP Committee'
 author = 'Enrico Faulhaber, Markus Zolliker'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -89,6 +89,9 @@ pygments_style = 'sphinx'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+# sort by source instead of alphabetic
+autodoc_member_order = 'bysource'
+
 default_role = 'any'
 
 # -- Options for HTML output ----------------------------------------------
@@ -136,7 +139,7 @@ html_sidebars = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SECoPdoc'
+htmlhelp_basename = 'Frappydoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -163,7 +166,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'SECoP.tex', 'SECoP source documentation',
+    (master_doc, 'Frappy.tex', 'Frappy source documentation',
      'Enrico Faulhaber, Markus Zolliker', 'manual'),
 ]
 
@@ -173,7 +176,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'secop', 'SECoP source documentation',
+    (master_doc, 'frappy', 'Frappy source documentation',
      [author], 1)
 ]
 
@@ -184,8 +187,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'SECoP', 'SECoP source documentation',
-     author, 'SECoP', 'One line description of project.',
+    (master_doc, 'Frappy', 'Frappy source documentation',
+     author, 'Frappy', 'One line description of project.',
      'Miscellaneous'),
 ]