Draft: Api docs
Generating API docs with OpenSCAD docsgen.
-
Write a load more API docs -
Either wait for fixes to OpenSCAD docsgen to be released, or make some sort of more defined tag of the fixed version -
Work out how we are deploying this.
openscad_docsgen
Should we be using
openscad_docsgen
Pros of - It is already written and mostly works
openscad_docsgen
Cons of - Really picky about everything being formatted exactly
- Throws errors if certain information is provided an not other info
- Requires a lot of manual copying of information (file name, function name, usage, etc) with no checking that it is consistent with the actual code.
- We will need to pin a version as there are often breaking changes without warning as it is really only deigned to do the docs for their own project BOSL2
Edited by Julian Stirling