Constraints docs [WIP]

[adam-urbanczyk]

This PR will resolve #469 .

[codecov]

Codecov Report

Merging #524 (0c27f3a) into master (b22436c) will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #524      +/-   ##
==========================================
+ Coverage   93.90%   93.94%   +0.04%     
==========================================
  Files          30       30              
  Lines        6106     6115       +9     
  Branches      639      640       +1     
==========================================
+ Hits         5734     5745      +11     
+ Misses        236      235       -1     
+ Partials      136      135       -1     

Impacted Files	Coverage Δ
cadquery/assembly.py	90.00% <100.00%> (ø)
cadquery/cq.py	88.92% <100.00%> (+0.24%)	⬆️
tests/test_cadquery.py	99.04% <100.00%> (+<0.01%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b22436c...0c27f3a. Read the comment docs.

[jmwright]

@adam-urbanczyk It looks like you might have deleted the following message, so I'm assuming you figured it out. If not, let me know and I'll reply.

@jmwright would you know why this happens:

/home/docs/checkouts/readthedocs.org/user_builds/cadquery/checkouts/524/doc/index.rst:33: WARNING: toctree contains reference to nonexisting document 'assy'

[adam-urbanczyk]

It is solved @jmwright , sorry for the noise.

[adam-urbanczyk]

OK, I think it is ready for review.

[jmwright]

@adam-urbanczyk It looks like you've got a typical black lint check failure.

[jmwright]

@adam-urbanczyk Thanks! Other than the two comments I've made it looks good.

[marcus7070]

I built this locally and it looks good to me. I think it would be worth introducing the 5 argument version of Assembly.constrain since it's the more flexible version, but perhaps that's a job for the next PR.

[adam-urbanczyk]

Do you see a natural place to introduce it in this doc @marcus7070 ?

[adam-urbanczyk]

Alright, I think all is resolved now. I propose to merge this today.

[jmwright]

+1 to merge