mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Moved Key Concepts to top level

Browse source
This commit is contained in:
gumyr 2023-06-28 14:58:36 -04:00
parent 489fcb02f9
commit aecdf69fd5
4 changed files with 9 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/index.rst
View file

@ -96,6 +96,8 @@ Table Of Contents
introduction.rst introduction.rst
installation.rst installation.rst
key_concepts.rst
key_concepts_algebra.rst
introductory_examples.rst introductory_examples.rst
tutorials.rst tutorials.rst
objects.rst objects.rst

11
docs/introduction.rst
View file

@ -270,17 +270,6 @@ customized to match the look and feel of your company's documentation. They also
provide multiple output formats, support for multiple languages and can be provide multiple output formats, support for multiple languages and can be
integrated with code management tools. integrated with code management tools.
****************************************
Key Concepts (builder mode)
****************************************
.. include:: key_concepts.rst
****************************************
Key Concepts (algebra mode)
****************************************
.. include:: key_concepts_algebra.rst
************************ ************************
Advantages Over CadQuery Advantages Over CadQuery

4
docs/key_concepts.rst
View file

@ -1,3 +1,7 @@
###########################
Key Concepts (builder mode)
###########################
There are two primary APIs provided by build123d: builder and algebra. The builder There are two primary APIs provided by build123d: builder and algebra. The builder
api may be easier for new users as it provides some assistance and shortcuts; however, api may be easier for new users as it provides some assistance and shortcuts; however,
if you know what a Quaternion is you might prefer the algebra API which allows if you know what a Quaternion is you might prefer the algebra API which allows

3
docs/key_concepts_algebra.rst
View file

@ -1,3 +1,6 @@
###########################
Key Concepts (algebra mode)
###########################
Build123d's algebra mode works on objects of the classes ``Shape``, ``Part``, ``Sketch`` and ``Curve`` and is based on two concepts: Build123d's algebra mode works on objects of the classes ``Shape``, ``Part``, ``Sketch`` and ``Curve`` and is based on two concepts: