From ebae0fbcacab6ff29ddbdadfdb4beebe0141e0ea Mon Sep 17 00:00:00 2001 From: Rob Date: Wed, 22 Jan 2025 16:24:04 -0500 Subject: [PATCH] Heading Edits --- scripts/addons/docs/overview.rst | 12 ++++++------ scripts/addons/docs/style.rst | 2 +- scripts/addons/docs/workflows.rst | 6 +++--- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/scripts/addons/docs/overview.rst b/scripts/addons/docs/overview.rst index b1816e3f..caade6fe 100644 --- a/scripts/addons/docs/overview.rst +++ b/scripts/addons/docs/overview.rst @@ -10,13 +10,13 @@ Fabex (formerly BlenderCAM) code can be broken down into categories: 5. Dependencies Core Functions -============== +**************** The core function of the Fabex addon is to take whatever object is in the viewport and generate toolpaths along that object according to a milling strategy set by the user. These operations can be exported alone, or combined into chains to be exported and run together. Extra Functions -=============== +***************** Beyond simply creating toolpaths for existing objects, Fabex can also create the objects (curves) and edit them through a number of operations. There are modules dedicated to creating reliefs, joinery, puzzle joinery and gears. @@ -24,19 +24,19 @@ There are modules dedicated to creating reliefs, joinery, puzzle joinery and gea There is also a simulation module to allow a preview of what the final product will look like, as well as an asynchronous module that allows progress reports on calculations. Reference Files -=============== +****************** Presets for machines, tools, operations and post-processors. User Interface -============== +**************** Files related to Blender's UI - panels, menus, pie menus, popup dialogs etc. Dependencies -============ +*************** Python wheels - executable binaries packed in for all supported systems. Complete Addon Layout ---------------------- +*********************** :: diff --git a/scripts/addons/docs/style.rst b/scripts/addons/docs/style.rst index 9f7f19e5..58a26db3 100644 --- a/scripts/addons/docs/style.rst +++ b/scripts/addons/docs/style.rst @@ -20,7 +20,7 @@ It will ensure that your spacing, indentation etc are in line with the project g Most Code Editors/IDEs are able to integrate the Black formatter, so you can format your code while you work. Project Structure -================= +****************** Fabex is a huge addon, with many different functions, added by many different contributors over the course of 12 years of development! In order to avoid conflicts, bugs and import errors a hierarchy has been established: diff --git a/scripts/addons/docs/workflows.rst b/scripts/addons/docs/workflows.rst index 6ea3cecf..e2e54297 100644 --- a/scripts/addons/docs/workflows.rst +++ b/scripts/addons/docs/workflows.rst @@ -12,7 +12,7 @@ In the root folder of the repository, there is a folder called ``.github``, and This folder contains a series of ``.yaml`` or ``.yml`` (either will work) files that describe what will trigger the workflow to start (e.g.: push, pull request etc), and which workflow file to run (e.g.: ``build_and_test.yaml``) Build and Test -============== +**************** ``build_and_test.yaml`` allows you to specify which version of Blender to build and test against, along with various other options. It will be triggered by a push or pull request and it will then: @@ -23,7 +23,7 @@ It will be triggered by a push or pull request and it will then: - upload the addon file that it created along with a log of the test results Create New Release -================== +******************** ``create_release.yaml`` allows you to specify the addon version that you want to create. The maintainer can decide whether the changes constitute a MAJOR, MINOR or PATCH release (e.g.: ``v1.5.12``): @@ -33,7 +33,7 @@ The maintainer can decide whether the changes constitute a MAJOR, MINOR or PATCH - PATCH - a typo, or bugfix - the ``.12`` in ``1.5.12`` Docs Pages -========== +*********** ``docs_pages.yml`` will build a complete documentation website based on the files in the ``docs`` folder. Using the sphinx/Google docstring format allow this action to pull comments out of the code, and format them the same way as the Blender or Shapely docs.