Improved docs based on failures of test_docs.py
This commit is contained in:
parent
a718a8bcfd
commit
3b65ac9efa
15
README
15
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.
|
||||
|
|
|
@ -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):
|
||||
|
|
Loading…
Reference in a new issue