Changeset 7031 for main/waeup.sirp/branches

Timestamp:

8 Nov 2011, 13:23:34 (13 years ago)

Author:

uli

Message:

• Pin Sphinx version to 1.0.7. Apparently this is the last version not producing errors.
• Fix some ReST markup for sphinx.

Location:

main/waeup.sirp/branches/ulif-extimgstore

Files:

• buildout.cfg (modified) (1 diff)
• src/waeup/sirp/browser/resources.py (modified) (12 diffs)
• src/waeup/sirp/browser/theming.py (modified) (2 diffs)
• src/waeup/sirp/imagestorage.py (modified) (1 diff)
• src/waeup/sirp/university/certificatecontainer.py (modified) (3 diffs)

main/waeup.sirp/branches/ulif-extimgstore/buildout.cfg

@@ -54 +54 @@
 zope.xmlpickle = 3.4.0
 # Require latest version...
-Sphinx =
+Sphinx = 1.0.7
 ZODB3 = 3.10.3
 docutils = 0.7

main/waeup.sirp/branches/ulif-extimgstore/src/waeup/sirp/browser/resources.py

@@ -38 +38 @@
 #:
 #: * In the `update()` method of the responsible view/page/form
-#:   require the JavaScript code to be rendered into the page:
+#:   require the JavaScript code to be rendered into the page::
 #:
 #:     from waeup.sirp.browser.resources import datepicker
-#:     ...
-#:     class MyPage(...):
-#:       ...
+#:     # ...
+#:     class MyPage(...):
+#:       # ...
 #:       def update(self):
 #:         datepicker.need()
@@ -51 +51 @@
 #:
 #: * In your HTML code add some ``<input>`` or ``<div>`` tag with
-#:   ``class`` set to ``datepicker``, like this::
+#:   ``class`` set to ``datepicker``, like this:
+#:
+#:   .. code-block:: html
 #:
 #:     <input type="text" name="entrydate" class="datepicker" />
@@ -85 +87 @@
 #: ``"datepicker-de-year"``
 #:    same but also adds a select field for year
-#: 
+#:
 #: ``"datepicker-us"``
 #:    renders date in format ``MM/DD/YYYY`` (U.S. format)
@@ -97 +99 @@
 #: If you want generate alert or confirm messages then you have to perform
 #: two steps:
-#: * In the `update()` method of the responsible view/page/form
-#:   require the JavaScript code to be rendered into the page:
+#:
+#: * In the `update()` method of the responsible view/page/form
+#:   require the JavaScript code to be rendered into the page::
 #:
 #:     from waeup.sirp.browser.resources import datepicker
-#:     ...
-#:     class MyPage(...):
-#:       ...
+#:     # ...
+#:     class MyPage(...):
+#:       # ...
 #:       def update(self):
 #:         warning.need()
@@ -109 +112 @@
 #:   This way all required JavaScripts will be rendered correctly
 #:   into the HTML page generated.
-#: 
+#:
 #:   In your HTML code add some <input> or <a> tag with onClick event:
 #:
-#:   <input type="submit" name="xyz" value="abc"/>
-#:          onclick="return confirmPost('Are you sure?')">
+#:   .. code-block:: html
+#:
+#:        <input type="submit" name="xyz" value="abc"/>
+#:               onclick="return confirmPost('Are you sure?')">
 warning = ResourceInclusion(waeup_sirp, 'warning.js')
 
 #: If you have many select boxes in a from which have to be selected at the same
-# time you have to perform
-#: two steps:
-#: * In the `update()` method of the responsible view/page/form
-#:   require the JavaScript code to be rendered into the page:
+#: time you have to perform two steps:
+#:
+#: * In the `update()` method of the responsible view/page/form
+#:   require the JavaScript code to be rendered into the page::
 #:
 #:     from waeup.sirp.browser.resources import toggleall
-#:     ...
-#:     class MyPage(...):
-#:       ...
+#:     # ...
+#:     class MyPage(...):
+#:       # ...
 #:       def update(self):
 #:         toggleall.need()
@@ -134 +139 @@
 #:   In your HTML code add some <input> tag with onClick event:
 #:
-#:   <input type="checkbox" onClick="toggle(this, 'entries')" />
-
+#:   .. code-block:: html
+#:
+#:    <input type="checkbox" onClick="toggle(this, 'entries')" />
 toggleall = ResourceInclusion(waeup_sirp, 'toggleall.js')
 
@@ -141 +147 @@
 #: ``tabs``.
 #:
-#:
 #: If you want jQuery tabs for some <div>s in your page then you
 #: have to perform two steps:
 #:
 #: * In the `update()` method of the responsible view/page/form
-#:   require the JavaScript code to be rendered into the page:
+#:   require the JavaScript code to be rendered into the page::
 #:
 #:     from waeup.sirp.browser.resources import tabs
-#:     ...
-#:     class MyPage(...):
-#:       ...
+#:     # ...
+#:     class MyPage(...):
+#:       # ...
 #:       def update(self):
 #:         tabs.need()
@@ -159 +164 @@
 #:
 #: * In your HTML code add some ``<div>`` tag with ``class`` set to
-#    ``tabs``, like this::
-#:    
+#:   ``tabs``, like this:
+#:
+#:    .. code-block:: html
+#:
 #:      <div id="tabs">
 #:        <ul>
@@ -195 +202 @@
 #: A stylesheet for datatables
 datatables_css = ResourceInclusion(waeup_sirp, 'datatables.css')
-                                  
+
 #: A resource that turns HTML tables into sortable, searchable and :
 #: multi-page widgets using jQuery and the dataTables plugin available
@@ -204 +211 @@
 #:
 #: * In the `update()` method of the responsible view/page/form
-#:   require the JavaScript code to be rendered into the page:
+#:   require the JavaScript code to be rendered into the page::
 #:
 #:     from waeup.sirp.browser.resources import datatable
-#:     ...
-#:     class MyPage(...):
-#:       ...
+#:     # ...
+#:     class MyPage(...):
+#:       # ...
 #:       def update(self):
 #:         datatable.need()
@@ -217 +224 @@
 #:
 #: * Assign a ``display dataTable`` class to the HTML table you want to tune:
-#:    
+#:
+#:   .. code-block:: html
+#:
 #:      <table class="display dataTable">
 #:        <thead>
@@ -246 +255 @@
 #: Register basic YUI based CSS as a resource.
 reset_fonts_grids = ResourceInclusion(
-    waeup_sirp, 'yuirfg.css')    
-    
+    waeup_sirp, 'yuirfg.css')
+
 yuiapp_css = ResourceInclusion(
     waeup_sirp, 'yuiapp.css',
-    depends=[reset_fonts_grids])     
+    depends=[reset_fonts_grids])
 
 #: Register basic WAeUP base CSS (which is based on ``yuiapp.css`` as a

main/waeup.sirp/branches/ulif-extimgstore/src/waeup/sirp/browser/theming.py

@@ -88 +88 @@
     A named global utility implementing
 
-      :class:`zope.schema.interfaces.IVocabularyFactory
+      :class:`zope.schema.interfaces.IVocabularyFactory`
 
     and registered under the name
 
       'waeup.sirp.browser.theming.ThemesVocabulary'
-    
+
     Interface fields that wish to provide a list of available themes
     can require a 'named vocabulary', i.e. set:
@@ -107 +107 @@
     grok.implements(IVocabularyFactory)
     grok.name('waeup.sirp.browser.theming.ThemesVocabulary')
-    
+
     def __call__(self, context):
         """Deliver a vocabulary of available themes.

main/waeup.sirp/branches/ulif-extimgstore/src/waeup/sirp/imagestorage.py

@@ -457 +457 @@
 
     An ExtFileStore instance is available as a global utility
-    implementing :iface:`waeup.sirp.interfaces.IExtFileStore`.
+    implementing :class:`waeup.sirp.interfaces.IExtFileStore`.
 
     To add and retrieve files from the storage, use the appropriate

main/waeup.sirp/branches/ulif-extimgstore/src/waeup/sirp/university/certificatecontainer.py

@@ -26 +26 @@
 
     Each :class:`CertificateContainer` provides
-    :iface:`ICertificateContainer`.
+    :class:`ICertificateContainer`.
     """
     grok.implements(ICertificateContainer)
@@ -35 +35 @@
 
         The `certificate` must be an object implementing
-        :iface:`waeup.sirp.university.interfaces.ICertificate`. If
+        :class:`waeup.sirp.university.interfaces.ICertificate`. If
         not, a :exc:`TypeError` is raised.
 
@@ -75 +75 @@
 
         The certificate must be an object implementing
-        :iface:`waeup.sirp.university.interfaces.ICertificate`. If
+        :class:`waeup.sirp.university.interfaces.ICertificate`. If
         not, a :exc:`TypeError` is raised.