gen_geom Namespace Reference

Functions
	docs_lib_path (path)
	get_readme (dir_path)
	get_filetype_links (dir_path, extension)
	get_images (dir_path)
	gen_geom_docs (droot, title, is_sources=False)
	gen_docs (fname)

Variables
	root = os.path.join("..", "lib")
	abs_root = os.path.abspath(root)
	geom = os.path.join(abs_root, "geometry")
str	outfile = "geom.md"

Function Documentation

docs_lib_path()

gen_geom.docs_lib_path

(

path

)

Path from the published docs/ root to a file under lib/.

Definition at line 11 of file gen_geom.py.

gen_docs()

gen_geom.gen_docs

(

fname

)

Definition at line 87 of file gen_geom.py.

gen_geom_docs()

gen_geom.gen_geom_docs	(		droot,
			title,
			is_sources = False )

Definition at line 47 of file gen_geom.py.

get_filetype_links()

gen_geom.get_filetype_links	(		dir_path,
			extension )

Definition at line 29 of file gen_geom.py.

get_images()

gen_geom.get_images

(

dir_path

)

Definition at line 38 of file gen_geom.py.

get_readme()

gen_geom.get_readme

(

dir_path

)

Look in directory dir_path for a file called README.md and return
it's contents if available

Definition at line 17 of file gen_geom.py.

Variable Documentation

abs_root

gen_geom.abs_root = os.path.abspath(root)

Definition at line 7 of file gen_geom.py.

geom

gen_geom.geom = os.path.join(abs_root, "geometry")

Definition at line 8 of file gen_geom.py.

outfile

str gen_geom.outfile = "geom.md"

Definition at line 145 of file gen_geom.py.

root

gen_geom.root = os.path.join("..", "lib")

Definition at line 6 of file gen_geom.py.