Commit Graph

43 Commits

Author SHA1 Message Date
3131a1f9ea Fix screw holes in parametric enclosure example 2022-03-05 18:12:51 +11:00
e91714d3a9 added docs on the CQ API layers (#917)
* added docs on the CQ different APIs

As invoked with https://github.com/CadQuery/cadquery/issues/909

This PR aims to bring more documentation about the different CadQuery APIs and how one can take advantage of them.

This has been written with my own understanding prism so it is rather subjective.  I'm not sure these concepts have been properly named before so this is an attempt to clarify things for eveybody

* grammer correction

* Update doc/primer.rst

Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>

* Update doc/primer.rst

Co-authored-by: Marcus Boyd <mwb@geosol.com.au>

Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>
Co-authored-by: Marcus Boyd <mwb@geosol.com.au>
2021-11-16 18:43:23 +01:00
a6cbf22fb7 doc/examples.rst: removed outdated SVG warning 2021-11-02 20:28:09 +10:30
aba24c0ed5 Added docs for new extrude capabilities (#894)
* Added docs for new extrude capabilities

Added examples for extrude and cutblind until extrusion parameter

Updated weird leftover text in Example page

* added note on relative axis coords for Workplane.revolve

* added mixed extrude cutblind example
2021-10-31 09:54:52 +10:30
9cef5558cf Merge pull request #863 from martinbudden/spelling_corrections
Fix spelling mistakes and typos.
2021-08-27 13:17:52 -04:00
015d8b33ae Fix spelling mistakes and typos. 2021-08-25 23:38:52 +01:00
e623d063af Fix inconsistent 2D and 3D spellings 2021-08-20 15:50:27 +03:00
247f0e6f3c Edit doc referring to old centerOption behaviour (#847)
This part of the doc was referring to the centerOption being the centerOfMass of a face by default. I changed it to refer to the new behaviour

Co-authored-by: Marcus Boyd <mwb@geosol.com.au>
2021-08-19 16:54:01 +09:30
baaa8d0f91 Fix inconsistent examples code style 2021-08-15 22:59:38 +03:00
550f77461c Fix inconsistent examples code style 2021-08-15 10:33:09 +03:00
b018d54bb2 Fix inconsistent examples code style 2021-08-15 10:10:44 +03:00
9e481b41a1 Typo fixes
Found via `codespell -q 3 -S *.js -L ba`
2021-07-30 13:48:22 -04:00
ea270062ce Update some examples (#775)
* Update some examples for workplane centerOption default ProjectedOrigin

* Typo in doc/examples.rst

Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>

Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>
2021-06-01 08:57:12 +02:00
a9e867061a Doc fix
Fixed two broken links in the OCCT bottle example.
2021-03-15 16:52:30 +10:30
606eb2773e offset2D for construction (#639)
* Added forConstruction option to Workplane.offset2D

* Added Workplane.offset2D example

Co-authored-by: Adam Urbańczyk <adam-urbanczyk@users.noreply.github.com>
2021-02-19 10:49:09 +10:30
b6beba7cb1 Centered option (#617)
* Added 2d centered option to rect

* Added single bool center option to box

* Add single bool center option to sphere

* Added single bool center option to wedge

* Added 2d centered option to rarray

* Black fix

* Centered docstrings

Change all docstrings for centered options to be consistent and more
clear

* Docstring fixes

* Fix type hint on wedge method
2021-02-10 18:02:43 +01:00
94e0976119 Fix examples and start testing them (#609)
* Fix examples

* Added test for examples

* Fix example testing code

* Sweep example fix

* Reformat examples

* Test examples from the docs too

* Add docutils to the test requirements

* Example test fix on win+cleanup

* Use union
2021-01-31 19:00:21 +01:00
a03648c842 Change to ProjectedOrigin (#532)
* Change to ProjectedOrigin

* Fix most tests

* Fix remaining tests

* Fix example building

* Update selector docs

* Fix the bottle+formatting changes

* Renamed centered to xycentered

* Ignore utils for coverage calculation
2020-12-08 18:32:57 +01:00
c42fa77ac0 Add mirror from face features (with example now fixed) (#527)
* Add the ability to mirror from a selected face

* Fix errors in example.rst

* Add mirror from face features (with example now fixed)

* recommit merge conflicts in shape.py that were stopping CI merging into master

* use correct variable name when selecting face

* formatting with black v19 instead of black v21

* add missing string literal types and clean up docstring

* Add volume assertions to the test cases

* black formatting

* Mypy fix

* Restructured mirror

* update examples to use basePoint instead of basePointVector

* Add tests for other workplane strings and non union option to increate code coverage

* Add test to check that exception is thown for incorrect input

* Go back to basePointVector

* Update arg naming in examples

* Mirror all objects

* Typo fix

Co-authored-by: Adam Urbańczyk <adam-urbanczyk@users.noreply.github.com>
2020-12-08 08:26:53 +01:00
c7b7e9592f Integrate sphinxcadquery to visualize 3D parts (#111)
* Integrate `sphinxcadquery` to visualize 3D parts

* Try different default export tolerance

* Change the tolerance for toString too

* Tighter angularTolerance for toString

Co-authored-by: Adam Urbańczyk <adam-urbanczyk@users.noreply.github.com>
2020-08-18 17:27:51 +02:00
96cea210b5 Add more examples for the shell method (#396)
* Add more examples for the shell method

* Mention selectors instead of add

* Remove Workplane.add and add ref to selector_reference

* Change coding style for selecting multiple faces

Co-authored-by: Adam Urbańczyk <adam-urbanczyk@users.noreply.github.com>
2020-07-11 22:58:22 +02:00
c82e908e61 Documentation update 2020-06-22 08:42:16 +02:00
d0f2576a60 doc/examples.rst: fix a typo 2020-03-14 19:44:18 +10:30
911c08f453 removed getTagged from docs 2020-01-23 21:06:17 +10:30
89e75470d0 Added examples to docs 2020-01-23 21:06:17 +10:30
653549dd90 Fixed line continuations in examples per #221 2019-11-30 14:57:29 -05:00
0267833a38 Spline example fix 2019-10-15 19:46:07 +02:00
8cb3893dab Update polyline example 2019-09-13 20:19:57 +02:00
5f873da52f Cycloidal gear example update 2019-02-24 21:55:22 +01:00
abe9f66a89 Added an example for parametricCurve usage 2019-02-24 21:43:32 +01:00
5be119459e Fix bottle example again 2019-02-20 21:10:53 +01:00
80fcd41c53 Fix polylines example 2019-02-20 19:20:56 +01:00
66222d4c2e Box example fix 2019-02-20 19:14:40 +01:00
558553db80 Fix the bottle example in the docs 2019-02-20 19:00:52 +01:00
00bbb34f17 Used spell checker to find several other mis-spellings. 2019-01-30 06:32:37 -05:00
b99ac29a4f Went through and updated the docs source to change FreeCAD and CQFM content and references to PythonOCC and CQ-editor. 2019-01-17 13:25:51 -05:00
7225d84905 1. Add a mirroring example into doc/example.rst; 2. Add a tolerance parameter into BoundingBox function, and default it as 0.1, otherwise, it's very slow when compile the docs with sphinx-build, don't know why; 3. Add a testBoundingBox function into TestCadQuery.py file... 2016-01-20 16:56:48 +08:00
2154a7bfbd fixed various documentation errors. changed license to apache 2015-12-12 15:08:38 -05:00
142a5c88d8 workable version of cqgi version 2015-12-09 21:01:14 -05:00
190980d4a1 got first directive workign 2015-12-08 22:36:19 -05:00
a967e1f0b9 Tried to get documentation Into Shape 2015-11-28 21:05:20 -05:00
977eb08657 now sphinxdoc works 2013-04-23 20:33:39 -04:00
8943b8dd10 renamed folders to standard ones 2013-04-15 21:22:54 -04:00