added introduction_logic nodes_moving a cube, removed collapse.py, re…

…factored & updated images of getting_started

.gitignore

@@ -1,4 +1,9 @@
 build
+/exts/__pycache__
+/resources/templates
+/resources/theme/layout.html
+.nvimrc
+/drafts/images
 
 # QTCreator
 *.config
@@ -8,6 +13,3 @@ build
 *.user
 *.cflags
 *.cxxflags
-/source/__pycache__
-/ext/__pycache__
-TODO.md

resources/theme/css/rtd_dark.css

@@ -0,0 +1,181 @@
+/*!
+ * @name          Readthedocs
+ * @namespace     http://userstyles.org
+ * @description	  Styles the documentation pages hosted on Readthedocs.io
+ * @author        Anthony Post
+ * @homepage      https://userstyles.org/styles/142968
+ * @version       0.20170529055029
+ *
+ * Modified by Aloïs Dreyfus: 20200527-1037
+ * Modified by Erik Kalkoken: 20220615
+ */
+
+@media (prefers-color-scheme: dark) {
+   /* aum added */
+
+	.admonition {
+	/* .admonition, .note { */
+		background-color: #2d2d2d !important;
+	}
+
+   .admonition-title {
+      color: rgba(40, 40, 40, 1.0) !important;
+   }
+
+   .important .admonition-title {
+		background-color: #FF5A00 !important;
+   }
+
+   .warning .admonition-title  { 
+      background-color: #FF302A !important;
+   }
+
+   .seealso .admonition-title  { 
+      background-color: rgba(100, 100, 100, 1.0) !important;
+   }
+
+   .nt, .nf {
+      color: lightblue !important;
+   }
+
+/* Draws a box around menuselection role. */
+/* Temporary fix for "theme(0.2.5b2)" bug: no box around 'kbd' role. */
+   .menuselection, .kbd.docutils.literal {
+   	font-size: 90%;
+   	font-weight: normal;
+   	background-color: rgba(50, 50, 50, 0.65) !important;
+      color: white !important;
+   	border: solid #E1E4E5 1px;
+   	white-space: nowrap;
+   	padding: 2px 5px;
+   }
+
+/* 'kbd' role. */
+   .kbd.docutils.literal {
+   	font-family: "Lato", "proxima-nova", 
+         "Helvetica Neue", Arial, sans-serif;
+   	font-size: 85%;
+   	font-weight: normal;
+   	color: white !important;
+   }
+
+   figcaption {
+      margin-top: 15px;
+   }   
+
+	body {
+		text-align: justify;
+      background-color: rgba(40, 40, 40, 1.0) !important;
+   }
+
+   h3 {
+      margin-top: 5px !important;
+   }
+
+   figure {
+      margin-bottom: 10px !important;
+   }
+
+   /* aum added end*/
+
+	a:visited {
+		color: #bf84d8;
+	}
+
+   .rst-content .refbox .admonition-title{
+      background-color: rgba(255, 90, 00, 1.0) !important;
+      color: yellow;
+   }
+
+	pre, .gh, .docutils.literal.notranslate {
+		background-color: rgba(40, 40, 40, 1.0) !important;
+      color: white !important;
+	}
+
+	.wy-nav-content {
+		background: rgba(30, 30, 30, 1.0) !important;
+		color: aliceblue;
+	}
+
+	.method dt, .class dt, .data dt, .attribute dt, .function dt,
+	.descclassname, .descname {
+		background-color: #525252 !important;
+		color: white !important;
+      /*border: 0, 0, 0, 0;*/
+	}
+
+	.toc-backref {
+		color: grey !important;
+	}
+
+	code.literal {
+		background-color: #2d2d2d !important;
+		border: 1px solid #6d6d6d !important;
+	}
+
+	.wy-nav-content-wrap {
+		background-color: rgba(0, 0, 0, 0.6) !important;
+	}
+
+	.sidebar {
+		background-color: #191919 !important;
+	}
+
+	.sidebar-title {
+		background-color: #2b2b2b !important;
+	}
+
+	.xref, .py-meth {
+		color: #7ec3e6 !important;
+	}
+
+	.wy-side-nav-search {
+		background-color: inherit;
+		border-bottom: 1px solid #fcfcfc;
+	}
+
+	.wy-table thead, .rst-content table.docutils thead, .rst-content table.field-list thead {
+		background-color: #b9b9b9;
+	}
+
+	.wy-table thead th, .rst-content table.docutils thead th, .rst-content table.field-list thead th {
+		border: solid 2px #e1e4e5;
+	}
+
+	.wy-table thead p, .rst-content table.docutils thead p, .rst-content table.field-list thead p {
+		margin: 0;
+	}
+
+	.wy-table-odd td, .wy-table-striped tr:nth-child(2n-1) td, .rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td {
+		background-color: #343131;
+	}
+
+	.highlight .m {
+		color: inherit
+	}
+
+	/* Literal.Number */
+	.highlight .nv {
+		color: #3a7ca8
+	}
+
+	/* Name.Variable */
+
+	.rst-content .section .admonition ul {
+		margin-bottom: 0;
+	}
+
+	li.toctree-l1 {
+		margin-top: 5px;
+		margin-bottom: 5px;
+	}
+
+	.wy-menu-vertical li code {
+		color: rgba(200, 200, 200, 1.0) !important;
+		/*color: #E74C3C;*/
+	}
+
+	.wy-menu-vertical .xref {
+		color: #2980B9 !important;
+	}
+}

resources/theme/css/theme_overrides.css

@@ -32,6 +32,13 @@ rst-content .admonition-title { background-color: #404040 }/*
 
 /* aum end */
 
+/* aum added */
+
+/* justify text */
+.rst-content { text-align: justify }
+
+/* aum end */
+
 h5 {margin-bottom: 5px}
 
 /* Sidebar menu links. */
@@ -60,6 +67,7 @@ input[type="number"], input[type="tel"], input[type="color"] {
 }
 
 /* Fixes overlay of "align-right" images on block. */
+/* aum : does not work as expected */
 .rst-content .admonition {overflow: auto}
 
 /* Boxed paragraphs. */

source/conf.py

@@ -35,7 +35,8 @@
 # -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.5'
+# 1.8 needed for 'html_css_files' and 'html_js_files' - docs.readthedocs.io
+needs_sphinx = '1.8'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -44,10 +45,6 @@
 extensions = [
     'youtube',
     'vimeo',
-    'collapse',
-    #'myst-parser',
-    #'sphinx_togglebutton',
-    #'sphinx_toolbox.collapse',
     #'sphinx.ext.mathjax',
     #'sphinx.ext.intersphinx',
     #'sphinx.ext.todo',
@@ -98,7 +95,7 @@
 
 # Theme options
 html_theme_options = {
-    "navigation_with_keys": True,
+   "navigation_with_keys": True,
    # included in the title
    "display_version": False,
    "collapse_navigation": True, # slows build down; useful
@@ -117,8 +114,10 @@
 html_static_path = ["../resources/theme"] # _static
 
 if html_theme == "sphinx_rtd_theme":
-    html_css_files = ["css/theme_overrides.css"]
-#    html_css_files = ["css/custom.css"]
+   html_css_files = ["css/theme_overrides.css"]
+# for production, switch to above theme_overrides.css
+   # html_css_files = ["css/rtd_dark.css"]
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
@@ -168,7 +167,6 @@
      'UPBGE Community', 'manual'),
 ]
 
-
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
@@ -178,8 +176,7 @@
      [author], 1)
 ]
 
-
-# -- Options for Texinfo output ----------------------------------------------
+# -- Options for Texinfo output ----------------------------------------------- 
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,

source/index.rst

@@ -1,27 +1,25 @@
 .. UPBGE Manual documentation master file, created by
    sphinx-quickstart on Sun Jul 8 18:28:15 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. TODO::
-   - remove 'sphinx-toolbox' from pip installation 'requirements.txt' file, and linux installation text (contribute.rst), and link to /exts/collapse.py file instead DONE
-
-   - fix 488 / 1430 build warning messages DONE
-
-   - spellcheck all files
-
-   - glossary needs a lot of love
+   You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.
 
 ============
 UPBGE Manual
 ============
 
 Welcome to UPBGE's documentation! Here you will find definitions of the available tools and features in UPBGE, step-by-step tutorials to certain tasks and a lot of examples for game logic programming with detailed information.
 
-Visit the `UPBGE's website <https://upbge.org/>`__ or `contribute to this manual <https://github.com/UPBGE/UPBGE-Docs>`__. Contribution guidelines are in the *Contribute* chapter of this manual.
+Visit the `UPBGE's website <https://upbge.org/>`__ or `contribute <https://github.com/UPBGE/UPBGE-Docs>`__ to this manual. Contribution guidelines are in the :ref:`Contribute <contribute-index>` chapter.
 
 Also, if you want to read the whole manual offline you can download it from `this link <https://upbge.org/docs/latest/manual/UPBGE_Manual.zip>`__.
 
+.. tip:: **Site navigation**
+
+   Keyboard navigation is supported - use arrow keys :kbd:`left/right` for previous/next page, and :kbd:`up/down` to scroll the page up/down.
+   Press :kbd:`Alt-left/right` to go back/forward by browser history. To focus the *Search* field, press :kbd:`/` (slash) key, :kbd:`Tab` to unfocus, :kbd:`Enter` to search.
+
+.. note::
+   See :ref:`contribute-about` for a cheatsheet of most common abbreviations used in this manual.
+
 .. toctree::
    :maxdepth: 2
    :caption: Manual

source/manual/contribute/about.rst

@@ -1,16 +1,16 @@
 .. _contribute-about:
 
-++++++++++++++++++++++
+==============================
 About the UPBGE Manual
-++++++++++++++++++++++
+==============================
 
 The purpose is to provide a complete and concise *reference manual*, with:
 
-   - Insight into Blender/UPBGE's way of working, its internal (technical) design, in order to understand options and tools;
-   - Detailed functional description of all features, tools and options in UPBGE.
+- Insight into Blender/UPBGE's way of working, its internal (technical) design, in order to understand options and tools;
+- Detailed functional description of all features, tools and options in UPBGE.
 
 Conventions
-===========
+++++++++++++++++++++++++++++++
 
 .. note:: These conventions are for people reading the manual. We have a more detailed list of conventions for authors under the :doc:`Writing Style </manual/contribute/writing_style>` section.
 

source/manual/contribute/contribute.rst

@@ -66,7 +66,8 @@ If using `Homebrew <https://brew.sh/>`__, run the following commands in the term
 
 ``brew install git``
 
-.. TODO:: someone check if macOS instructions are complete
+..
+   someone check if macOS instructions are complete
 
 Windows
 +++++++
@@ -140,7 +141,8 @@ Troubleshooting
 #. If *rst* formatting is not displayed as expected, try adding::
    
    .. highlight:: rst
-   directive to the top of the ``.rst`` file.
+   
+directive to the top of the ``.rst`` file.
 
 ------------------
 Editing the Manual