diff options
Diffstat (limited to 'docs/source/codebase.rst')
| -rw-r--r-- | docs/source/codebase.rst | 21 |
1 files changed, 7 insertions, 14 deletions
diff --git a/docs/source/codebase.rst b/docs/source/codebase.rst index ba5f1e46..28d73802 100644 --- a/docs/source/codebase.rst +++ b/docs/source/codebase.rst @@ -45,7 +45,7 @@ Software Stack * Web application - * `Paste Deploy <http://pythonpaste.org/deploy/>`_ and + * `Paste Deploy <http://pythonpaste.org/deploy/>`_ and `Paste Script <http://pythonpaste.org/script/>`_: we'll use this for configuring and launching the application @@ -83,22 +83,21 @@ After you've run buildout, you're faced with the following directory tree:: mediagoblin/ - |- mediagoblin/ #source code + |- mediagoblin/ # source code | |- tests/ | |- templates/ | |- auth/ | \- submit/ - |- docs/ #documentation + |- docs/ # documentation | - | #the below directories are generated by - | #buildout. + | # the below directories are generated by buildout. | - |- bin/ #scripts + |- bin/ # scripts |- develop-eggs/ |- eggs/ |- mediagoblin.egg-info/ |- parts/ - |- user_dev/ #sessions, etc + |- user_dev/ # sessions, etc As you can see, all the code for GNU MediaGoblin is in the @@ -108,7 +107,7 @@ Here are some interesting files and what they do: :routing.py: maps url paths to views :views.py: views handle http requests -:models.py: holds the mongodb schemas---these are the data structures +:models.py: holds the mongodb schemas---these are the data structures we're working with You'll notice that there are several sub-directories: tests, @@ -122,9 +121,3 @@ templates, auth, submit, ... and media item submission. If you look in these directories, you'll see they have their own ``routing.py``, ``view.py``, and ``models.py`` in addition to some other code. - - -Recipes -======= - -FIXME - write this |