blendercam/scripts/addons/docs/index.rst

38 wiersze
1.1 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 Fabex's API Documentation!
==========================================
.. toctree::
:maxdepth: 1
:caption: Contents:
User Guide
------------
user_guide
Developer Guide
-----------------
overview
styleguide
testing
workflows
This site serves as an introduction to the code behind Fabex.
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.