Commit d2fe2dd4 authored by Hamaker, Alec's avatar Hamaker, Alec
Browse files

created a bash script to generate documentation with pydoc

parent b6a06404
Loading
Loading
Loading
Loading

doc.sh

0 → 100755
+20 −0
Original line number Diff line number Diff line
#!/bin/bash

EXT='.py'

for entry in src/common/*
do
	if [[ $entry == *$EXT* ]]; then
		base=$(basename $entry $EXT)
		pydoc-markdown -I src -m common.$(basename $entry $EXT) > docs/$(basename $entry $EXT).md
	fi
done

for entry in src/common/mixins/*
do

	if [[ $entry == *$EXT* ]]; then
		base=$(basename $entry $EXT)
		pydoc-markdown -I src -m common.mixins.$(basename $entry $EXT) > docs/mixins.$(basename $entry $EXT).md
	fi
done

docs/__init__.md

0 → 100644
+5 −0
Original line number Diff line number Diff line
<a name="common.__init__"></a>
# common.\_\_init\_\_

Common package to assist in rapid package development.
+5 −0
Original line number Diff line number Diff line
<a name="common.mixins.__init__"></a>
# common.mixins.\_\_init\_\_

Provide mixins for multiple abstract classes.

src/common/__init__.md

0 → 100644
+0 −0

Empty file added.

src/common/database.md

0 → 100644
+0 −0

Empty file added.

Loading