Scripting and Documenting OpenSCAD designs using openscad-amu and Doxygen by rasarmg

Last crawled date: 4 years, 2 months ago

Using Doxygen with and Scripting OpenSCAD designs.
This thing has been significantly improved. Please see the design flow and template that was developed based on the exploration done here .
Language-based mechanical design, such as that used by OpenSCAD, offers
the potential for increased design efficiencies through the use of
reusable parameterized design libraries. As with software design,
Language-based mechanical design efficiency directly correlates
with well documented robust libraries and good automated design flows.
For some time I have been looking for a good way to both automate (ie: script)
OpenSCAD design flows and document library components. For documentation,
it seems natural to leverage a tool like Doxygen to couple the documentation
with design at the source level where it has the best chance to remain coherent.
Although OpenSCAD is currently the most capable open source CAD tool for
language-based mechanical design, it presently lacks a scripting interface that would
make it more conducive to automated design flows.
This examples present a way to both document OpenSCAD designs and script the
invocation of OpenSCAD for target component compilation.
Pre-build documentation and targets can be found in the file autodoc_pb.zip
and a pre-built PDF reference manual can be found in the file refman_pb.pdf.
To rebuild the documentation yourself from the source file, install the
prerequisite software and then type make. Afterwards view the html-based
documentation by opening the file: autodoc/html/index.html
and the latex generated pdf-version by opening the file:autodoc/latex/refman.pdf