7b9a48d591
* Remove roadmap * Create workplane.rst * Add text * Restructure primer.rst * Create citing.rst * Add citing to index.rst * Update README.md Mention citing * Add citation.cff * Delete citation.cff.yaml * Create CITATION.cff * Update CITATION.cff * Update CITATION.cff * Update CITATION.cff * Update CITATION.cff * Apply suggestions from code review Co-authored-by: Jeremy Wright <wrightjmf@gmail.com> * Add refs * tweak --------- Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>
66 lines
1.6 KiB
ReStructuredText
66 lines
1.6 KiB
ReStructuredText
|
|
|
|
CadQuery 2 Documentation
|
|
===================================
|
|
|
|
CadQuery is an intuitive, easy-to-use Python library for building parametric 3D CAD models. It has several goals:
|
|
|
|
* 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
|
|
|
|
* Create parametric models that can be very easily customized by end users
|
|
|
|
* Output high quality CAD formats like STEP, AMF and 3MF in addition to traditional STL
|
|
|
|
* Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser
|
|
|
|
See CadQuery in Action
|
|
-------------------------
|
|
|
|
This `Getting Started Video <https://youtu.be/lxhBNOE7GVs>`_ will show you what CadQuery can do. Please note that the video has not been updated for CadQuery 2 and still shows CadQuery use within FreeCAD.
|
|
|
|
|
|
Quick Links
|
|
------------------
|
|
|
|
* :ref:`quickstart`
|
|
* `CadQuery CheatSheet <_static/cadquery_cheatsheet.html>`_
|
|
* :ref:`apireference`
|
|
|
|
Table Of Contents
|
|
-------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
intro.rst
|
|
installation.rst
|
|
quickstart.rst
|
|
designprinciples.rst
|
|
primer.rst
|
|
workplane.rst
|
|
sketch.rst
|
|
assy.rst
|
|
free-func.rst
|
|
vis.rst
|
|
fileformat.rst
|
|
examples.rst
|
|
apireference.rst
|
|
API Cheatsheet <https://cadquery.readthedocs.io/en/latest/_static/cadquery_cheatsheet.html>
|
|
selectors.rst
|
|
classreference.rst
|
|
importexport.rst
|
|
cqgi.rst
|
|
extending.rst
|
|
citing.rst
|
|
|
|
|
|
|
|
Indices and tables
|
|
-------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|