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:

scripts/addons/docs/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../cam/'))
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'BlenderCAM'
+copyright = '2024'
+author = 'Vilem Novak, Alain Pelletier & Contributors'
+release = '1.0.38'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'autoapi.extension',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.graphviz',
+    'sphinx.ext.inheritance_diagram'
+]
+
+autoapi_type = 'python'
+autoapi_dirs = ['../cam']
+autoapi_ignore = ['*nc*', '*presets*', '*ui_panels*', '*pie_menu*', '*tests*', '*wheels*']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '*nc*', '*presets*', '*ui_panels*', '*pie_menu*', '*tests*', '*wheels*']
+
+add_module_names = False
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_book_theme'
+html_static_path = ['_static']
+html_logo = "_static/logo_blendercam.png"
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/pppalain/blendercam",
+            "icon": "fa-brands fa-square-github",
+            "type": "fontawesome",
+        },
+        {
+            "name": "Matrix",
+            "url": "https://riot.im/app/#/room/#blendercam:matrix.org",
+            "icon": "fa-solid fa-comments",
+            "type": "fontawesome",
+        },
+    ]
+}

scripts/addons/docs/index.rst

@@ -0,0 +1,30 @@
+.. BlenderCAM documentation master file, created by
+   sphinx-quickstart on Sun Sep  8 08:23:06 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to BlenderCAM's API Documentation!
+==========================================
+
+This site serves as an introduction to the code behind BlenderCAM.
+
+If you just want to know how to use the addon to mill projects, check out the `wiki <https://blendercam.com/documentation/>`_
+
+This resource is for people who want to contribute code to BlenderCAM, people who want to modify the addon for their needs, or anyone who simply want to better understand what is happening 'under the hood'.
+
+:doc:`overview` offers a guide to the addon files and how they relate to one another.
+
+:doc:`styleguide` gives tips on editors, linting, formatting etc.
+
+:doc:`testing` has information on how to run and contribute to the Test Suite.
+
+:doc:`workflows` contains an explanation of how the addon, testing and documentation are automated via Github Actions.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   overview
+   styleguide
+   testing
+   workflows

scripts/addons/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

scripts/addons/docs/modules.rst

@@ -0,0 +1,7 @@
+cam
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   cam

scripts/addons/docs/overview.rst

@@ -0,0 +1,4 @@
+Overview
+===========
+
+The package cam

scripts/addons/docs/styleguide.rst

@@ -0,0 +1,4 @@
+Style Guide
+===========
+
+Use this style!

scripts/addons/docs/testing.rst

@@ -0,0 +1,4 @@
+Test Suite
+===========
+
+This is how tests work

scripts/addons/docs/workflows.rst

@@ -0,0 +1,4 @@
+Workflows & Actions
+===================
+
+Github Actions automate part of the workflow