diff options
| -rw-r--r-- | docs/conf.py | 11 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/modules/index.rst | 18 | ||||
| -rw-r--r-- | docs/modules/router.rst | 3 |
4 files changed, 32 insertions, 6 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5df7f9b29..6a349082f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,16 @@ import sys, os # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. -#sys.path.append(os.path.abspath('some/directory')) +parent = os.path.dirname(os.path.dirname(__file__)) +sys.path.append(os.path.abspath(parent)) +wd = os.getcwd() +os.chdir(parent) +os.system('%s setup.py test -q' % sys.executable) +os.chdir(wd) + +for item in os.listdir(parent): + if item.endswith('.egg'): + sys.path.append(os.path.join(parent, item)) # General configuration # --------------------- diff --git a/docs/index.rst b/docs/index.rst index 85e072f2c..abe99954a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ -.. repoze.bfg documentation. +.. _index: -Welcome to repoze.bfg's documentation! -====================================== +repoze.bfg Documentation +======================== Contents: diff --git a/docs/modules/index.rst b/docs/modules/index.rst new file mode 100644 index 000000000..38cd5a29d --- /dev/null +++ b/docs/modules/index.rst @@ -0,0 +1,18 @@ +.. _modules: + +API documentation +================= + +:mod:`repoze.bfg` +----------------- + +The :mod:`repoze.bfg` package contains the code nececessary to create +and run an application. + +Sub-packages +------------ + +.. toctree:: + :maxdepth: 2 + + router diff --git a/docs/modules/router.rst b/docs/modules/router.rst index bb6037956..435a7ebd0 100644 --- a/docs/modules/router.rst +++ b/docs/modules/router.rst @@ -1,7 +1,7 @@ .. _router_module: :mod:`repoze.bfg.router` ------------------- +------------------------ .. automodule:: repoze.bfg.router @@ -9,6 +9,5 @@ =================== .. autoclass:: Router - :members: __init__ __call__ .. autofunction:: repoze.bfg.router.make_app |
