Mercurial Mercurial > pub > hg > cubicweb / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | zip | gz | bz2 | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[doc] Start documenting the API
authorChristophe de Vienne <christophe@unlish.com>
Thu, 08 Jan 2015 23:00:56 +0100
changeset 10494 b6f00889355c
parent 10493 64b4e1def4ec
child 10495 5bd914ebf3ae
[doc] Start documenting the API Related to #4832808
doc/api/__init__.rst file | annotate | diff | comparison | revisions
doc/api/appobject.rst file | annotate | diff | comparison | revisions
doc/api/cwvreg.rst file | annotate | diff | comparison | revisions
doc/api/dataimport.rst file | annotate | diff | comparison | revisions
doc/api/req.rst file | annotate | diff | comparison | revisions
doc/api/rset.rst file | annotate | diff | comparison | revisions
doc/api/urlpublishing.rst file | annotate | diff | comparison | revisions
doc/api/urlrewrite.rst file | annotate | diff | comparison | revisions
doc/api/web.rst file | annotate | diff | comparison | revisions
doc/conf.py file | annotate | diff | comparison | revisions
doc/index.rst file | annotate | diff | comparison | revisions 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/__init__.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,115 @@
+.. _index_module:
+
+:mod:`cubicweb`
+===============
+
+.. automodule:: cubicweb
+
+    Exceptions
+    ----------
+
+    Base exceptions
+    ~~~~~~~~~~~~~~~
+
+    .. autoexception:: ProgrammingError
+        :show-inheritance:
+
+    .. autoexception:: CubicWebException
+        :show-inheritance:
+
+    .. autoexception:: InternalError
+        :show-inheritance:
+
+    .. autoexception:: SecurityError
+        :show-inheritance:
+
+    .. autoexception:: RepositoryError
+        :show-inheritance:
+
+    .. autoexception:: SourceException
+        :show-inheritance:
+
+    .. autoexception:: CubicWebRuntimeError
+        :show-inheritance:
+
+    Repository exceptions
+    ~~~~~~~~~~~~~~~~~~~~~
+
+    .. autoexception:: ConnectionError
+        :show-inheritance:
+
+    .. autoexception:: AuthenticationError
+        :show-inheritance:
+
+    .. autoexception:: BadConnectionId
+        :show-inheritance:
+
+    .. autoexception:: UnknownEid
+        :show-inheritance:
+
+    .. autoexception:: UniqueTogetherError
+        :show-inheritance:
+
+    Security Exceptions
+    ~~~~~~~~~~~~~~~~~~~
+
+    .. autoexception:: Unauthorized
+        :show-inheritance:
+
+    .. autoexception:: Forbidden
+        :show-inheritance:
+
+    Source exceptions
+    ~~~~~~~~~~~~~~~~~
+
+    .. autoexception:: EidNotInSource
+        :show-inheritance:
+
+    Registry exceptions
+    ~~~~~~~~~~~~~~~~~~~
+
+    .. autoexception:: UnknownProperty
+        :show-inheritance:
+
+    Query exceptions
+    ~~~~~~~~~~~~~~~~
+
+    .. autoexception:: QueryError
+        :show-inheritance:
+
+    .. autoexception:: NotAnEntity
+        :show-inheritance:
+
+    .. autoexception:: MultipleResultsError
+        :show-inheritance:
+
+    .. autoexception:: NoResultError
+        :show-inheritance:
+
+    .. autoexception:: UndoTransactionException
+        :show-inheritance:
+
+
+    Misc
+    ~~~~
+
+    .. autoexception:: ConfigurationError
+        :show-inheritance:
+
+    .. autoexception:: ExecutionError
+        :show-inheritance:
+
+    .. autoexception:: BadCommandUsage
+        :show-inheritance:
+
+    .. autoexception:: ValidationError
+        :show-inheritance:
+
+
+    Utilities
+    ---------
+
+    .. autoclass:: Binary
+    .. autoclass:: CubicWebEventManager
+    .. autofunction:: onevent
+    .. autofunction:: validation_error
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/appobject.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,10 @@
+.. _appobject_module:
+
+:mod:`cubicweb.appobject`
+=========================
+
+.. automodule:: cubicweb.appobject
+
+    .. autoclass:: AppObject
+        :show-inheritance:
+        :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/cwvreg.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,38 @@
+.. _cwvreg_module:
+
+:mod:`cubicweb.cwvreg`
+======================
+
+.. automodule:: cubicweb.cwvreg
+
+    .. autoclass:: CWRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: InstancesRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: ETypeRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: ViewsRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: ActionsRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: CtxComponentsRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: BwCompatCWRegistry
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: CWRegistryStore:
+        :show-inheritance:
+        :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/dataimport.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,63 @@
+.. _dataimport_module:
+
+:mod:`cubicweb.dataimport`
+==========================
+
+.. automodule:: cubicweb.dataimport
+
+    Utilities
+    ---------
+
+    .. autofunction:: count_lines
+
+    .. autofunction:: ucsvreader_pb
+
+    .. autofunction:: ucsvreader
+
+    .. autofunction:: callfunc_every
+
+    .. autofunction:: lazytable
+
+    .. autofunction:: lazydbtable
+
+    .. autofunction:: mk_entity
+
+    Sanitizing/coercing functions
+    -----------------------------
+
+    .. autofunction:: optional
+    .. autofunction:: required
+    .. autofunction:: todatetime
+    .. autofunction:: call_transform_method
+    .. autofunction:: call_check_method
+
+    Integrity functions
+    -------------------
+
+    .. autofunction:: check_doubles
+    .. autofunction:: check_doubles_not_one
+
+    Object Stores
+    -------------
+
+    .. autoclass:: ObjectStore
+        :members:
+
+    .. autoclass:: RQLObjectStore
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: NoHookRQLObjectStore
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: SQLGenObjectStore
+        :show-inheritance:
+        :members:
+
+    Import Controller
+    -----------------
+
+    .. autoclass:: CWImportController
+        :show-inheritance:
+        :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/req.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,11 @@
+.. _req_module:
+
+:mod:`cubicweb.req`
+===================
+
+.. automodule:: cubicweb.req
+
+    .. autoexception:: FindEntityError
+
+    .. autoclass:: RequestSessionBase
+        :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/rset.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,10 @@
+.. _rset_module:
+
+:mod:`cubicweb.rset`
+===================
+
+.. automodule:: cubicweb.rset
+
+    .. autoclass:: ResultSet
+        :members:
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/urlpublishing.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,36 @@
+.. _urlpublishing_module:
+
+:mod:`cubicweb.web.views.urlpublishing`
+=======================================
+
+.. automodule:: cubicweb.web.views.urlpublishing
+
+    .. autoexception:: PathDontMatch
+
+    .. autoclass:: URLPublisherComponent
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: URLPathEvaluator
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: RawPathEvaluator
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: EidPathEvaluator
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: RestPathEvaluator
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: URLRewriteEvaluator
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: ActionPathEvaluator
+        :show-inheritance:
+        :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/urlrewrite.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,18 @@
+.. _urlrewrite_module:
+
+:mod:`cubicweb.web.views.urlrewrite`
+=======================================
+
+.. automodule:: cubicweb.web.views.urlrewrite
+
+    .. autoclass:: URLRewriter
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: SimpleReqRewriter
+        :show-inheritance:
+        :members:
+
+    .. autoclass:: SchemaBasedRewriter
+        :show-inheritance:
+        :members:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/api/web.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -0,0 +1,21 @@
+.. _web_module:
+
+:mod:`cubicweb.web`
+===================
+
+.. automodule:: cubicweb.web
+
+    Exceptions
+    ----------
+
+    .. autoexception:: DirectResponse
+    .. autoexception:: InvalidSession
+    .. autoexception:: PublishException
+    .. autoexception:: LogOut
+    .. autoexception:: Redirect
+    .. autoexception:: StatusResponse
+    .. autoexception:: RequestError
+    .. autoexception:: NothingToEdit
+    .. autoexception:: ProcessFormError
+    .. autoexception:: NotFound
+    .. autoexception:: RemoteCallFailed
--- a/doc/conf.py	Thu Jan 08 23:00:33 2015 +0100
+++ b/doc/conf.py	Thu Jan 08 23:00:56 2015 +0100
@@ -140,7 +140,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
--- a/doc/index.rst	Thu Jan 08 23:00:33 2015 +0100
+++ b/doc/index.rst	Thu Jan 08 23:00:56 2015 +0100
@@ -99,6 +99,15 @@
 Reference documentation
 ~~~~~~~~~~~~~~~~~~~~~~~
 
+API
+'''
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    api/*
+
 .. toctree::
     :maxdepth: 1
cubicweb