kaan/MCAD-Library
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Improved docs based on failures of test_docs.py

Browse source
This commit is contained in:
Elmom 2010-10-30 12:57:26 +03:00
parent a718a8bcfd
commit 3b65ac9efa
2 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README
View file

@ -38,17 +38,25 @@ Currently Provided Tools:
Other tools (alpha and beta quality): Other tools (alpha and beta quality):
* nuts_and_bolts.scad: for creating metric and imperial bolt/nut holes * nuts_and_bolts.scad: for creating metric and imperial bolt/nut holes
* bearing.scad: standard/custom bearings * bearing.scad: standard/custom bearings
* screw.cad: screws and augers * screw.scad: screws and augers
* materials.scad: color definitions for different materials * materials.scad: color definitions for different materials
* stepper.scad: NEMA standard stepper outlines * 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 * math.scad: general math functions
* constants.scad: mathematical constants * constants.scad: mathematical constants
* curves.scad: mathematical functions defining curves * curves.scad: mathematical functions defining curves
* units.scad: easy metric units * units.scad: easy metric units
* utilities.scad: geometric funtions and misc. useful stuff * utilities.scad: geometric funtions and misc. useful stuff
* teardrop.scad (http://www.thingiverse.com/thing:3457): parametric teardrop module * 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 == == Development ==
You are welcome to fork this project in github and request pulls. I will try to 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 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 and tracebacks for failing tests. It's very simplistic still, but it should test
that no syntax errors occur at least. 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.

2
test_docs.py
View file

@ -8,7 +8,7 @@ def pytest_generate_tests(metafunc):
metafunc.addcall(funcargs=dict(filename=fpath.basename)) metafunc.addcall(funcargs=dict(filename=fpath.basename))
for fpath in dirpath.visit('*.py'): for fpath in dirpath.visit('*.py'):
name = fpath.basename name = fpath.basename
if not name.startswith('test_'): if not (name.startswith('test_') or name.startswith('_')):
metafunc.addcall(funcargs=dict(filename=fpath.basename)) metafunc.addcall(funcargs=dict(filename=fpath.basename))
def test_README(filename): def test_README(filename):