Link format fixed - md to rst syntax

pull/277/head^2
Rob 2024-12-22 10:52:00 -05:00
rodzic 60b0639fcd
commit bb5d8adb01
3 zmienionych plików z 10 dodań i 9 usunięć

Wyświetl plik

@ -1,7 +1,7 @@
===========
Overview
===========
BlenderCAM's code can be broken down into categories:
Fabex (formerly BlenderCAM) code can be broken down into categories:
1. Core Functions
2. Extra Functions
@ -11,12 +11,13 @@ BlenderCAM's code can be broken down into categories:
Core Functions
==============
The core function of the BlenderCAM 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.
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, BlenderCAM can also create the objects (curves) and edit them through a number of operations.
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,11 +25,11 @@ There is also a simulation module to allow a preview of what the final product w
Reference Files
===============
Presets for machines, tools, operations and preprocessors comprise the majority of the files in the addon.
Presets for machines, tools, operations and post-processors.
User Interface
==============
Files related to Blender's UI - all the panels, buttons etc that you can click on in the addon, as well as menus, pie menus, popup dialogs etc.
Files related to Blender's UI - panels, menus, pie menus, popup dialogs etc.
Dependencies
============

Wyświetl plik

@ -2,11 +2,11 @@ Style Guide
===========
As a Blender extension, Fabex follows the guidelines laid out by the Blender Foundation:
[Blender Code Best Practices](https://docs.blender.org/api/current/info_best_practice.html)
`Blender Code Best Practices <https://docs.blender.org/api/current/info_best_practice.html>``
[Extension Guidelines](https://docs.blender.org/manual/en/latest/advanced/extensions/getting_started.html#how-to-create-extensions)
`Extension Guidelines <https://docs.blender.org/manual/en/latest/advanced/extensions/getting_started.html#how-to-create-extensions>`
In short, Blender uses a modified version of the [pep8](https://peps.python.org/pep-0008/) standard, meaning:
In short, Blender uses a modified version of the `pep8 <https://peps.python.org/pep-0008/>` standard, meaning:
- Classes are `NamedLikeThis` - no spaces, all words capitalized
- Functions, modules, variables, etc are `named_like_this` - spaces replaced with underscores, no capital letters
- No `*` imports - e.g. `from module import *` should be rewritten to specify exactly what is being imported - `from module import Class, function, variable as other_name` etc.

Wyświetl plik

@ -41,7 +41,7 @@ Docs Pages
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.
This helps ensure that any changes made to the code are also made to the documentation, which helps avoid situations where a programmer has renamed a function or Class in the code, but forgotten to update the docs.
In order for this system to work, docstrings have to follow a specific format: [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
In order for this system to work, docstrings have to follow a specific format: `Google Style Python Docstrings <https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html>`
NOTE: