Commits

Anonymous committed 468558d

Fixing warnings. 0 remain again. Also updated how to build docs, as things have moved slightly. The process is now more streamlined.

Comments (0)

Files changed (3)

docs/building_docs.rst

 
 We need several additional packages to support documentation development:
 
+mapfish
+   tgext.geo relies on MapFish, so we install it.
 python_memcached
    This is requirement for the way we generate docs, provides memcache module
+sphinx
+   Sphinx_ is the tool used to generate html from the rst files.
 sqlalchemy
    This is required for the documentation to avoid generating warnings when
    it is built.
 .. code-block:: bash
 
 
-   easy_install sqlalchemy python_memcached tgext.geo
-
-.. note::  tgext.geo may complain about not being able to install one of its
-   dependencies: MapFish.   This is not critical for building the docs, but
-   if this continues to be a problem you can install it with::
-
-       easy_install -i http://dev.camptocamp.com/packages/mapfish/1.1/index --allow-hosts=dev.camptocamp.com mapfish==1.1
+   easy_install sqlalchemy python_memcached tgext.geo mapfish sphinx
 
 After this, you should be able to verify your TurboGears |version| installation with
 
    paster tginfo
 
 
-We also need Sphinx_ which enables us to generate html from the rst files.  This can be installed by running easy_install:
-
-.. code-block:: bash
-
-    easy_install sphinx
-
 Finally, we are ready to set up the documentation.   If you feel ready and
 willing to assist with the documentation efforts, I hope you have contacted
 mpedersen via IRC (see above).   In order to help with the documentation,

docs/modules/thirdparty/beaker.rst

 .. autoclass:: SignedCookie
 .. autoclass:: Session
 .. autoclass:: SessionObject
+.. autofunction:: b64decode
+.. autofunction:: b64encode
 
 Synchronization
 ---------------
 .. autoclass:: SyncDict
 .. autoclass:: WeakValuedRegistry
 .. autoclass:: ThreadLocal
-.. autofunction:: b64decode
-.. autofunction:: b64encode
 .. autofunction:: verify_directory
 .. autofunction:: encoded_path
 .. autofunction:: verify_options

docs/modules/thirdparty/webob.rst

 .. autofunction:: html_escape
 .. autofunction:: timedelta_to_seconds
 
-.. autoclass:: FakeCGIBody
-    :members:
-.. autoclass:: ResponseBodyFile
-    :members:
-.. autoclass:: AppIterRange
-    :members:
-.. autofunction:: _rfc_reference
-.. autofunction:: _cgi_FieldStorage__repr__patch
-
-
 :mod:`webob.acceptparse`
 ------------------------
 .. currentmodule:: webob.acceptparse
 .. autoclass:: EnvironHeaders
     :members:
 
+:mod:`webob.descriptors`
+------------------------
+.. currentmodule:: webob.descriptors
+.. autofunction:: _rfc_reference
+
 :mod:`webob.etag`
 ------------------------
 .. currentmodule:: webob.etag
 .. autoclass:: NoVars
     :members:
 
+:mod:`webob.request`
+--------------------
+.. currentmodule:: webob.request
+
+.. autoclass:: FakeCGIBody
+    :members:
+.. autofunction:: _cgi_FieldStorage__repr__patch
+
+
+:mod:`webob.response`
+---------------------
+.. currentmodule:: webob.response
+
+.. autoclass:: ResponseBodyFile
+    :members:
+.. autoclass:: AppIterRange
+    :members:
+    
 :mod:`webob.statusreasons`
 --------------------------
 .. currentmodule:: webob.statusreasons
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.