From 3b65ac9efa28bcb7e25537c1cda12f3fa32a7e1c Mon Sep 17 00:00:00 2001 From: Elmom Date: Sat, 30 Oct 2010 12:57:26 +0300 Subject: [PATCH] Improved docs based on failures of test_docs.py --- README | 15 +++++++++++++-- test_docs.py | 2 +- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README b/README index 09c7f91..57d6d09 100644 --- a/README +++ b/README @@ -38,17 +38,25 @@ Currently Provided Tools: Other tools (alpha and beta quality): * nuts_and_bolts.scad: for creating metric and imperial bolt/nut holes * bearing.scad: standard/custom bearings -* screw.cad: screws and augers +* screw.scad: screws and augers * materials.scad: color definitions for different materials * stepper.scad: NEMA standard stepper outlines +* servos.scad: servo outlines +* boxes.scad: box with rounded corners +* triangles.scad: simple triangles -Utils: +Very generally useful functions and constants: * math.scad: general math functions * constants.scad: mathematical constants * curves.scad: mathematical functions defining curves * units.scad: easy metric units * utilities.scad: geometric funtions and misc. useful stuff * teardrop.scad (http://www.thingiverse.com/thing:3457): parametric teardrop module +* shapes.scad: simple shapes by Catarina Mota + +External utils that generate and and process openscad code: +* openscad_testing.py: testing code, see below +* openscad_utils.py: code for scraping function names etc. == Development == You are welcome to fork this project in github and request pulls. I will try to @@ -71,3 +79,6 @@ python and uses py.test (might be compatible with Nose also). Just type py.test inside the lib dir in a terminal and you should see a part of the tests passing and tracebacks for failing tests. It's very simplistic still, but it should test that no syntax errors occur at least. + +The code is included in openscad_teting.py, and can be imported to be +used in other codebases. diff --git a/test_docs.py b/test_docs.py index 4aebf17..043be9a 100644 --- a/test_docs.py +++ b/test_docs.py @@ -8,7 +8,7 @@ def pytest_generate_tests(metafunc): metafunc.addcall(funcargs=dict(filename=fpath.basename)) for fpath in dirpath.visit('*.py'): name = fpath.basename - if not name.startswith('test_'): + if not (name.startswith('test_') or name.startswith('_')): metafunc.addcall(funcargs=dict(filename=fpath.basename)) def test_README(filename):