Document - sphinx

Tasks

• configure sphinx documentation with autodoc and apidoc
• modify theme
• configure autodoc to list all cqparts.params.Parameter classes (recursive) (perhaps modify docstring if applicable) List all cqparts.params.Parameter as valid constructor parameters. This could be tricky, and messy

#25 to deal with publishing.

[jmwright]

@fragmuffin I and @dcowden use docs embedded with the repo that are pushed to GitHub pages. The CadQuery library uses Sphinx, but I’ve very recently let GitHub push the docs out using its standard method with Jekyll.

Sphinx method with CadQuery: https://github.com/dcowden/cadquery/tree/master/doc http://dcowden.github.io/cadquery/

Here’s the path I went down with embedded docs and Jekyll. https://pages.github.com/

One nice thing about having your docs embedded with your repo is that you can manage them the same way as your code. Every time you push to master your docs are updated and pushed out to GitHub pages.

[dcowden]

having created lots of models over the years, it would be great if we could arrange a way to re-orient models without forcing the designer to orient them correctly in the first place.
We have to expect that assemblies will be made from mixes of cq-created parts and external parts-- and its very cumbersome to force everyone to re-orient their models for positioning in the assembly.

What might be slick is to provide a way for model authors to create a mating coordinate system in terms of the corodinate systems already there in the model. This could be done using CQ, via STEP import even.

for example, perhaps I could do something like mates: { primary: defaultCsys.rotateX(180), secondary: faces(type=Cylinder).coordinateSystem() } Anyhow, the idea is three step process:

(1) create models, export to STEP or whatever if you want (2) create mates for each part, defined in terms of existing coordinate systems and/or geometrcy (3) link them together, either using mates or absolute positioning