Commit Graph

43 Commits

Author SHA1 Message Date
AU
995d1393bd Free function api (#1469)
* Initial free functions

* Mypy fixes

* Add a mypy plugin that handles _get*

* More helpers and fixes

* black

* More hooks

* More ops and primitives

* Fill with constraints and cap

* Minimal docstrings and mypy fix

* Bool op operators for Shape

* Extra docstring

* Added spline primitive

* Added alternative constructors

* Update solid

* Add shape normalization

* Add text

* Added moved overload

* Another moved overload

* Convert location constructor to multimethod

* Additional Loc constructor

* Extra vertex constructor

* Additional cone overload

* Start with tests

* Fix compouund normalization

* Bool op tests

* Additional Location overload

* test moved and fix bool ops

* Different cap params

* More tests

* Test revolve and offset

* Test sweep and loft

* Add bool ops

* More tests

* Test text

* Improve coverage for utils

* More move[d] and Location overloads

* Start working on some docs

* Update index

* Doc fix

* Typo fix

* More move/moved overloads

* Small doc update

* Better Location coverage

* Fix angle units in Location

* More docs and a usability fix

* Cosmetics

* Mypy fix

* Remove dead code

* Coverage tweaks

* More docs'

* Box centering and box/plane arg order

* Docs cosmetics - nicer sweep

* Apply suggestions

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

* Add docstrings

* Doc tweaks

* Bump multimethod version

* Add occ_impl.shapes

* Mention free funcs in the primer

* Typos

* Typo

* Punctuation

---------

Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>
2024-05-05 11:25:45 +02:00
20432b808c Fixed three typos. (#1474) 2024-01-02 15:31:01 -05:00
AU
de715468e3 Initial implementation of cq.Shape selectors (#1406)
* Initial implementation of cq.Shape selectors

* Return single Shape when possible

* Add test

* Refactor and prepare to deprecate .Vertices(), .Edges() & similar

* Simplify _entities

* Doc update
2023-10-08 11:03:34 +02:00
e323a219c1 Format documentation code blocks with blacken-docs 2023-07-22 14:45:06 +12:00
0d50ea946e Fix syntax errors in documentation code blocks
* Fix syntax errors that would cause an error when running blacken-docs.
* If default language code blocks are not Python, or are Python
  fragments, make them explicit with `.. code-block::`.
2023-07-22 14:44:38 +12:00
6c8030d26a add extrustion distance to get sample code working (#1275)
Without the parameter I got the following error message:
TypeError: extrude() missing 1 required positional argument: 'distance'
2023-02-18 21:22:17 +01:00
97457625ec Merge pull request #1058 from GandalfDG/doc_ref_fixes
Fix broken references in documentation
2022-06-01 06:08:28 -04:00
c2988dfa75 Grammar fix 2022-04-21 22:59:41 -06:00
02fa078231 fixed a few warnings in primer.rst 2022-04-20 15:40:47 -04:00
ee90f2ce28 Fix doc issue where parameters listed twice in description (#916)
* Update sphinx pin to version 4.4.0
* Remove sphinx extension sphinx_autodoc_typehints
2022-03-26 09:46:09 -04:00
ae8961ef09 Minor formatting 2022-03-18 22:09:47 -06:00
AU
fa4561b3be Handle kwargs+multimethods in a backward compatibile way (#923)
* CQ-specific multimethod

* Use cqmultimethod in cq.Shape

* Imports cleanup

* cqmultimethod test

* doc/primer: added multimethod section

Co-authored-by: Marcus Boyd <mwb@geosol.com.au>
2022-01-08 06:56:46 +10:30
AU
631b4efa95 Add cylinder 2021-11-18 07:43:39 +01:00
AU
d0c3ad37cb Merge branch 'master' into patch-2 2021-11-17 18:41:36 +01: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
9cef5558cf Merge pull request #863 from martinbudden/spelling_corrections
Fix spelling mistakes and typos.
2021-08-27 13:17:52 -04:00
37b4e235fe Merge pull request #839 from CadQuery/marcus7070/introspective-example-note
doc/primer.rst: introspective example additional note
2021-08-27 10:37:37 -04:00
015d8b33ae Fix spelling mistakes and typos. 2021-08-25 23:38:52 +01:00
7bcd80ecf2 Fix documentation wording 2021-08-19 16:46:12 +09:30
f48758f74b Add back wedge reference 2021-08-18 09:23:18 +03:00
cde3dd2464 Remove examples that don't exist in linked table 2021-08-15 07:48:38 +03:00
f8179394b9 doc/primer.rst: introspective example additional note 2021-08-03 11:46:36 +09:30
9e481b41a1 Typo fixes
Found via `codespell -q 3 -S *.js -L ba`
2021-07-30 13:48:22 -04:00
8fccc0c864 doc/primer: added introspective example (#821) 2021-07-23 14:43:24 +09:30
d0695ec594 Assy docs fix (#614) 2021-02-03 08:25:20 +01:00
cf275b0ec0 Constraints docs [WIP] (#524)
* Initial version of the constraints docs

* Adding the assy section

* apireference cleanup

* Include cutouts

* Roadmap cleanup

* _query cleanup

* Black fix

* Add RadiusNthSelector again

* Typo fix

* Paste error fix

* Show detailed selector docs

* Another typo fix

* Mention other constrain overload

* Added test for end()
2020-11-30 13:41:34 +01:00
292a0d8d0a Merge pull request #440 from CadQuery/assembly
Assembly support
2020-10-01 06:48:06 -04:00
43e8377eb3 Docs update 2020-09-30 18:18:40 +02:00
da07216688 Fix a typo. (#452)
* Fix a typo.

* Pin black version in travis

Co-authored-by: Adam Urbańczyk <adam-urbanczyk@users.noreply.github.com>
2020-09-22 08:11:36 +02:00
726616b582 Added basic docs 2020-09-04 13:11:16 +02:00
b9397c3132 Merge branch 'master' into adam-urbanczyk-location 2020-06-27 12:57:40 +02:00
02a8549f5c more introduction to Workplanes in the docs (#386) 2020-06-23 18:29:20 +02:00
c82e908e61 Documentation update 2020-06-22 08:42:16 +02:00
98a871c299 Fix just a few unimportant typos 2020-06-19 13:06:01 +02:00
04c8b80084 Added tags to primer/concepts docs 2020-01-23 21:06:17 +10:30
89e75470d0 Added examples to docs 2020-01-23 21:06:17 +10:30
d3ebdfd0a3 DOC: primer.rst: syntax, wording 2019-07-08 22:50:13 -04:00
00bbb34f17 Used spell checker to find several other mis-spellings. 2019-01-30 06:32:37 -05:00
142a5c88d8 workable version of cqgi version 2015-12-09 21:01:14 -05:00
a967e1f0b9 Tried to get documentation Into Shape 2015-11-28 21:05:20 -05:00
37e78284ad added missing rst files. published 0.1.7 2014-10-25 12:57:46 -04:00
5c763c8f9e make pip installer 2013-04-23 21:31:56 -04:00
8943b8dd10 renamed folders to standard ones 2013-04-15 21:22:54 -04:00