-.. Shaper python API documentation master file, created by
- sphinx-quickstart on Thu Oct 15 11:55:42 2015.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+Shaper textual interface documentation
+======================================
-Welcome to Shaper python API's documentation!
-=============================================
+Shaper provides two different textual interfaces that allows you to create
+models through python scripts:
+* a "direct" API, which allows you to create geometrical objects
+ without any parametric considerations
-Sketching operations
---------------------
+* a "parametric" API, which is very close to what is done
+ in the graphical interface and allows you to recalculate a model
+ when a parameter is changed
-.. toctree::
- :maxdepth: 2
+Parametric API
+--------------
- sketcher
- arc
+This API is implemented in the model Python package. A script written
+with the parametric API will typically begin with a code like below:
-Features
---------
+.. doctest::
-.. toctree::
- :maxdepth: 2
+ >>> import model
+ >>> model.begin()
+ >>> partset = model.moduleDocument()
+ >>> part = model.addPart(partset).document()
+ >>> plane = model.defaultPlane("XOY")
+ >>> sketch = model.addSketch(part, plane)
+ >>> line = sketch.addLine(0, 0, 0, 1)
- extrusion
+Features
+........
+This API provides functions for creating the features listed below.
+These functions return an interface to the feature that allow
+to modify the feature and retrieve data from it.
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ sketcher
+ model/*
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
-* :ref:`search`
-
