Changeset 12838

Timestamp:

31 Mar 2015, 17:31:34 (10 years ago)

Author:

Henrik Bettermann

Message:

Fix documentation. Remove all Sphinx warning messages.

Location:

main/waeup.ikoba/trunk

Files:

• docs/source/developerdocs/api/api_browser.rst (modified) (1 diff)
• docs/source/developerdocs/api/api_widgets.rst (modified) (1 diff)
• docs/source/developerdocs/api/browser/api_async.rst (added)
• docs/source/developerdocs/api/browser/api_breadcrumbs.rst (modified) (1 diff)
• docs/source/developerdocs/api/browser/api_captcha.rst (added)
• docs/source/developerdocs/api/browser/api_fileviewlets.rst (added)
• docs/source/developerdocs/api/browser/api_interfaces.rst (modified) (1 diff)
• docs/source/developerdocs/api/browser/api_layout.rst (modified) (1 diff)
• docs/source/developerdocs/api/browser/api_pages.rst (modified) (1 diff)
• docs/source/developerdocs/api/browser/api_pdf.rst (added)
• docs/source/developerdocs/api/browser/api_reports.rst (added)
• docs/source/developerdocs/api/browser/api_resources.rst (deleted)
• docs/source/developerdocs/api/browser/api_theming.rst (deleted)
• docs/source/developerdocs/api/browser/api_viewlets.rst (modified) (1 diff)
• docs/source/developerdocs/api/index.rst (modified) (2 diffs)
• docs/source/developerdocs/api/payments/api_currencies.rst (added)
• docs/source/developerdocs/api/widgets/api_restwidget.rst (deleted)
• src/waeup/ikoba/permissions.py (modified) (2 diffs)

main/waeup.ikoba/trunk/docs/source/developerdocs/api/api_browser.rst

@@ -18 +18 @@
    :maxdepth: 1
 
+   browser/api_async.rst
+   browser/api_breadcrumbs.rst
+   browser/api_captcha.rst
+   browser/api_exceptions.rst
+   browser/api_fileviewlets.rst
    browser/api_interfaces.rst
+   browser/api_layout.rst
    browser/api_pages.rst
+   browser/api_pdf.rst
+   browser/api_reports.rst
    browser/api_viewlets.rst
-   browser/api_layout.rst
-   browser/api_breadcrumbs.rst
-   browser/api_theming.rst
-   browser/api_resources.rst
-   browser/api_exceptions.rst

main/waeup.ikoba/trunk/docs/source/developerdocs/api/api_widgets.rst

@@ -20 +20 @@
    widgets/api_datewidget
    widgets/api_phonewidget
-   widgets/api_restwidget
    widgets/api_objectwidget

main/waeup.ikoba/trunk/docs/source/developerdocs/api/browser/api_breadcrumbs.rst

@@ -1 @@
-`browser.breadcrumbs` - Browser Breadcrumbs
-*******************************************
+`browser.breadcrumbs` - Breadcrumbs
+***********************************
 
 .. automodule:: waeup.ikoba.browser.breadcrumbs

main/waeup.ikoba/trunk/docs/source/developerdocs/api/browser/api_interfaces.rst

@@ -5 +5 @@
    :members:
    :undoc-members:
-
-   .. autointerface:: IBreadcrumb
-      :members:
-
-   .. autointerface:: IBreadcrumbIgnorable
-      :members:
-
-   .. autointerface:: IBreadcrumbContainer
-      :members:
-
-   .. autointerface:: ITheme
-      :members:

main/waeup.ikoba/trunk/docs/source/developerdocs/api/browser/api_layout.rst

@@ -1 @@
-`browser.layout` - Browser Layout
-*********************************
+`browser.layout` - Layout
+*************************
 
 .. automodule:: waeup.ikoba.browser.layout

main/waeup.ikoba/trunk/docs/source/developerdocs/api/browser/api_pages.rst

@@ -1 @@
-`browser.pages` - Browser Pages (Views)
-***************************************
+`browser.pages` - Pages (Views)
+*******************************
 
 .. automodule:: waeup.ikoba.browser.pages

main/waeup.ikoba/trunk/docs/source/developerdocs/api/browser/api_viewlets.rst

@@ -1 @@
-`browser.viewlets` - Browser Viewlets
-*************************************
+`browser.viewlets` - Viewlets
+*****************************
 
-Probably due to a bug in Sphinx autodoc couldn't import/find some classes and
-reported error: "grokcore, please check your spelling and sys.path".
-Thus, automodule has been temporarily disabled.
-
-..
-  .. automodule:: waeup.ikoba.browser.viewlets
-     :members:
-     :undoc-members:
-
+.. automodule:: waeup.ikoba.browser.viewlets
+   :members:
+   :undoc-members:

main/waeup.ikoba/trunk/docs/source/developerdocs/api/index.rst

@@ -23 +23 @@
    api_datacenter
    api_documents
+   api_image
    api_imagestorage
    api_interfaces
@@ -38 +39 @@
    api_sourcefactory
    api_startup
-   api_company
    api_userscontainer
    api_utils

main/waeup.ikoba/trunk/src/waeup/ikoba/permissions.py

@@ -28 +28 @@
     etc., that should be usable/readable by everyone.
 
-    We need this to be able to tune default permissions more
-    restrictive and open up some dedicated objects like the front
-    page.
     """
     grok.name('waeup.Public')
@@ -36 +33 @@
 class Anonymous(grok.Permission):
     """Only-anonymous-can-do-this-permission.
+
     """
     grok.name('waeup.Anonymous')