diff options
| author | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2012-02-24 01:28:19 +0100 |
|---|---|---|
| committer | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2012-02-24 01:28:36 +0100 |
| commit | 59274330932d5eae3b708c5e944a7ae452cdddaf (patch) | |
| tree | 9e52bf3816595064357f78485d1a4eb6afdf9198 /docs | |
| parent | dc16881ebf674295a3e855bfc4798a0ce8bd94d2 (diff) | |
| download | factory-boy-59274330932d5eae3b708c5e944a7ae452cdddaf.tar factory-boy-59274330932d5eae3b708c5e944a7ae452cdddaf.tar.gz | |
Improve docs.
Signed-off-by: Raphaël Barrois <raphael.barrois@polytechnique.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/internals.rst | 25 |
3 files changed, 27 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py index f50b1a6..7a67dfd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ import sys, os # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.dirname(os.path.abspath('.'))) # -- General configuration ----------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 2e0f4a3..eff5ac6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -59,6 +59,7 @@ Contents: examples subfactory + internals Indices and tables ================== diff --git a/docs/internals.rst b/docs/internals.rst new file mode 100644 index 0000000..75de63d --- /dev/null +++ b/docs/internals.rst @@ -0,0 +1,25 @@ +Factoy Boy's internals +====================== + + +declarations +------------ + +.. automodule:: factory.declarations + :members: + + +containers +---------- + +.. automodule:: factory.containers + :members: + + + +base +---- + +.. automodule:: factory.base + :members: + |