Add files via upload

scripts/addons/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

scripts/addons/docs/cam.opencamlib.rst

@@ -0,0 +1,29 @@
+cam.opencamlib package
+======================
+
+Submodules
+----------
+
+cam.opencamlib.oclSample module
+-------------------------------
+
+.. automodule:: cam.opencamlib.oclSample
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.opencamlib.opencamlib module
+--------------------------------
+
+.. automodule:: cam.opencamlib.opencamlib
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cam.opencamlib
+   :members:
+   :undoc-members:
+   :show-inheritance:

scripts/addons/docs/cam.rst

@@ -0,0 +1,327 @@
+cam package
+===========
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cam.nc
+   cam.opencamlib
+   cam.ui_panels
+
+Submodules
+----------
+
+cam.async\_op module
+--------------------
+
+.. automodule:: cam.async_op
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.autoupdate module
+---------------------
+
+.. automodule:: cam.autoupdate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.basrelief module
+--------------------
+
+.. automodule:: cam.basrelief
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.bridges module
+------------------
+
+.. automodule:: cam.bridges
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.cam\_chunk module
+---------------------
+
+.. automodule:: cam.cam_chunk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.cam\_operation module
+-------------------------
+
+.. automodule:: cam.cam_operation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.chain module
+----------------
+
+.. automodule:: cam.chain
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.collision module
+--------------------
+
+.. automodule:: cam.collision
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.constants module
+--------------------
+
+.. automodule:: cam.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.curvecamcreate module
+-------------------------
+
+.. automodule:: cam.curvecamcreate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.curvecamequation module
+---------------------------
+
+.. automodule:: cam.curvecamequation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.curvecamtools module
+------------------------
+
+.. automodule:: cam.curvecamtools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.engine module
+-----------------
+
+.. automodule:: cam.engine
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.exception module
+--------------------
+
+.. automodule:: cam.exception
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.gcodeimportparser module
+----------------------------
+
+.. automodule:: cam.gcodeimportparser
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.gcodepath module
+--------------------
+
+.. automodule:: cam.gcodepath
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.image\_utils module
+-----------------------
+
+.. automodule:: cam.image_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.involute\_gear module
+-------------------------
+
+.. automodule:: cam.involute_gear
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.joinery module
+------------------
+
+.. automodule:: cam.joinery
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.machine\_settings module
+----------------------------
+
+.. automodule:: cam.machine_settings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.numba\_wrapper module
+-------------------------
+
+.. automodule:: cam.numba_wrapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.ops module
+--------------
+
+.. automodule:: cam.ops
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.pack module
+---------------
+
+.. automodule:: cam.pack
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.parametric module
+---------------------
+
+.. automodule:: cam.parametric
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.pattern module
+------------------
+
+.. automodule:: cam.pattern
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.polygon\_utils\_cam module
+------------------------------
+
+.. automodule:: cam.polygon_utils_cam
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.preferences module
+----------------------
+
+.. automodule:: cam.preferences
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.preset\_managers module
+---------------------------
+
+.. automodule:: cam.preset_managers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.puzzle\_joinery module
+--------------------------
+
+.. automodule:: cam.puzzle_joinery
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.simple module
+-----------------
+
+.. automodule:: cam.simple
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.simulation module
+---------------------
+
+.. automodule:: cam.simulation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.slice module
+----------------
+
+.. automodule:: cam.slice
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.strategy module
+-------------------
+
+.. automodule:: cam.strategy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.testing module
+------------------
+
+.. automodule:: cam.testing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.ui module
+-------------
+
+.. automodule:: cam.ui
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.utils module
+----------------
+
+.. automodule:: cam.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.version module
+------------------
+
+.. automodule:: cam.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cam.voronoi module
+------------------
+
+.. automodule:: cam.voronoi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cam
+   :members:
+   :undoc-members:
+   :show-inheritance: