kopia lustrzana https://github.com/vilemduha/blendercam
36 wiersze
1.2 KiB
ReStructuredText
36 wiersze
1.2 KiB
ReStructuredText
.. 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!
|
|
==========================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Contents:
|
|
|
|
overview
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
styleguide
|
|
testing
|
|
workflows
|
|
|
|
|
|
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.
|