Files
cadquery/doc/index.rst

56 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2013-04-15 21:22:54 -04:00
.. CadQuery documentation master file, created by
sphinx-quickstart on Sat Aug 25 21:10:53 2012.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
2015-11-28 21:05:20 -05:00
CadQuery Documentation
2013-04-15 21:22:54 -04:00
===================================
2015-11-28 21:05:20 -05:00
CadQuery is an intuitive, easy-to-use python library for building parametric 3D CAD models. It has several goals:
2013-04-15 21:22:54 -04:00
2015-11-28 21:05:20 -05:00
* Build models with scripts that are as close as possible to how you'd describe the object to a human,
using a standard, already established programming language
2013-04-15 21:22:54 -04:00
2015-11-28 21:05:20 -05:00
* Create parametric models that can be very easily customized by end users
2013-04-15 21:22:54 -04:00
2015-11-28 21:05:20 -05:00
* Output high quality CAD formats like STEP and AMF in addition to traditional STL
* Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser
Quick Links
-------------------
For the impatient, here's where you probably want to get started
==================== ============================ ========================================================== ====================
:ref:`quickstart` :ref:`installation` `CadQuery CheatSheet <_static/cadquery_cheatsheet.html>`_ :ref:`apireference`
==================== ============================ ========================================================== ====================
Table Of Contents
-------------------
2013-04-15 21:22:54 -04:00
.. toctree::
:maxdepth: 2
intro.rst
2015-11-28 21:05:20 -05:00
installation.rst
2013-04-15 21:22:54 -04:00
quickstart.rst
2015-11-28 21:05:20 -05:00
designprinciples.rst
primer.rst
fileformat.rst
2013-04-15 21:22:54 -04:00
examples.rst
apireference.rst
selectors.rst
classreference.rst
2015-11-28 21:05:20 -05:00
extending.rst
roadmap.rst
2013-04-15 21:22:54 -04:00
Indices and tables
2015-11-28 21:05:20 -05:00
-------------------
2013-04-15 21:22:54 -04:00
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`