doc: Separate common settings

Makefile

@@ -5,8 +5,8 @@
 SPHINXOPTS    = -W
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = Pybricks
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = ev3dev
+BUILDDIR      = "$(SOURCEDIR)"/build
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -17,5 +17,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(MAKE) -C source/_images `[ "$@" = "clean" ] && echo clean || echo all`
+	@$(MAKE) -C "$(SOURCEDIR)"/_images `[ "$@" = "clean" ] && echo clean || echo all`
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

common/conf.py

@@ -44,7 +44,7 @@ extensions = [
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['../common/_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -134,7 +134,7 @@ else:
         'disclaimer': _DISCLAIMER,
     }
 
-html_logo = 'images/pybricks-logo-small.png'
+html_logo = '../common/images/pybricks-logo-small.png'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
@@ -152,7 +152,7 @@ html_theme_options = {
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['../common/_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -224,7 +224,7 @@ latex_documents = [
     (master_doc, ''.join([project, '-v', version, '.tex']), _TITLE, author, 'manual'),
 ]
 
-latex_logo = 'images/pybricks-logo-large.png'
+latex_logo = '../common/images/pybricks-logo-large.png'
 
 
 # -- Options for manual page output ---------------------------------------

ev3dev/_images/Makefile

@@ -0,0 +1,15 @@
+
+SRC_DIR = .
+OUT_DIR = ../images
+
+SVG := $(wildcard $(SRC_DIR)/*.svg)
+PNG := $(patsubst $(SRC_DIR)/%.svg,$(OUT_DIR)/%.png,$(SVG))
+DIR := ${CURDIR}
+
+all: $(PNG)
+
+clean:
+	rm -f $(PNG)
+
+$(OUT_DIR)/%.png: $(SRC_DIR)/%.svg
+	inkscape --file=$(DIR)/$< --export-area-drawing --export-png=$(DIR)/$@

ev3dev/conf.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Pybricks documentation build configuration file
+#
+import os
+import sys
+exec(open(os.path.abspath("../common/conf.py")).read())

ev3dev/images/.gitignore

@@ -0,0 +1,3 @@
+*.png
+!pybricks-logo-large.png
+!pybricks-logo-small.png

ev3dev/robotics.rst

@@ -0,0 +1,4 @@
+:mod:`robotics` -- Robotics module
+===========================================
+
+.. automodule:: robotics

ev3dev/signaltypes.rst

@@ -0,0 +1 @@
+.. include:: ../common/signaltypes.rst

ev3dev/tools.rst

@@ -0,0 +1 @@
+.. include:: ../common/tools.rst

source/motorcontrol.rst

@@ -1,86 +0,0 @@
-Motor Essentials
-=====================
-
-Intro
-
-
-
-Encoded Motors
-----------------
-
-.. _duty:
-
-Duty cycle
-^^^^^^^^^^
-TODO
-
-Angle encoder
-^^^^^^^^^^^^^
-TODO
-
-.. _ratio:
-
-Gear ratio
-^^^^^^^^^^
-
-TODO
-
-        ::
-
-            Example for one gear train: gears=[12, 36]
-             ____________
-            |            |
-            |    motor   |
-            |____________|
-                  ||
-                  || 12t      36t
-                ||||||  ||||||||||||||
-                              ||
-                              ||
-                          output axle
-
-
-            Example with multiple gear trains: gears=[[12, 20, 36], [20, 40], [20, 8, 40]]
-            _____________
-            |            |
-            |    motor   |
-            |____________|
-                  ||
-                  || 12t    20t           36t
-                ||||||  |||||||||||  ||||||||||||||
-                                           ||
-                                           ||
-                                        ||||||||  |||||||||||||||||
-                                            20t          || 40t
-                                                         ||
-                                                      ||||||||  |||  |||||||||||||||||
-                                                          20t    8t         || 40t
-                                                                            ||
-                                                                        output axle
-
-
-.. _maneuvers:
-
-Motor maneuvers
----------------
-
-
-Reference signal
-^^^^^^^^^^^^^^^^
-
-
-Automatic control
-^^^^^^^^^^^^^^^^^
-
-.. _pid:
-
-PID Parameters
-^^^^^^^^^^^^^^
-TODO
-
-
-.. _defaultpars:
-
-Default motor parameters
-------------------------
-TODO