poc/docs/index.txt
2017-08-12 10:33:19 -05:00

40 lines
1.2 KiB
Text

.. Python OCE Composer (poc) documentation master file, created by
sphinx-quickstart on Sat Aug 5 21:47:32 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Python OCE Composer (poc)
=========================
*poc* is a tool in the vein of *OpenSCAD* for creating 3D models in a high
level language with a minimum of boilerplate.
*poc* programs are Python2 programs, executed in an environment that
provides convenient shorthand for performing geometric operations.
*poc* uses OpenCASCADE to implement its geometric operations.
This means it has different strengths and weaknesses compared to *OpenSCAD*,
which uses CGAL. For instance, OpenCASCADE has `fillet` as a first-class
operation, while it lacks `minkowski` and `hull` which are quite frequently
used in *OpenSCAD*.
The the design of the *poc* standard library is very much in flux, and
there are likely to be compatibility-breaking changes as it develops.
For installation and setup instructions, see README.md.
.. toctree::
:maxdepth: 2
programs
examples
environment
poctools
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`