From 12b4de10be14ac82c07d2bb73411fce7dfc2cf89 Mon Sep 17 00:00:00 2001 From: schettino72 Date: Mon, 24 Jun 2013 23:35:24 +1200 Subject: [PATCH 1/2] docs. sphinx include API for _SchemaNode --- docs/api.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index e1f710d..e80abec 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -115,7 +115,7 @@ Types Schema-Related ~~~~~~~~~~~~~~ - .. autoclass:: SchemaNode + .. autoclass:: _SchemaNode :members: .. automethod:: __delitem__ @@ -124,6 +124,10 @@ Schema-Related .. automethod:: __iter__ + .. autoclass:: SchemaNode + :show-inheritance: + :members: + .. autoclass:: Schema .. autoclass:: MappingSchema From 55707ff8449e28b8a28863a646b5dea269dcfe27 Mon Sep 17 00:00:00 2001 From: schettino72 Date: Tue, 25 Jun 2013 11:01:03 +1200 Subject: [PATCH 2/2] docs. SchemaNode API show __doc__ and members inherited from _SchemaNode --- colander/__init__.py | 2 +- docs/api.rst | 7 ++----- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/colander/__init__.py b/colander/__init__.py index 527572b..26b150b 100644 --- a/colander/__init__.py +++ b/colander/__init__.py @@ -2081,7 +2081,7 @@ class _SchemaMeta(type): SchemaNode = _SchemaMeta( 'SchemaNode', (_SchemaNode,), - {} + {'__doc__': _SchemaNode.__doc__} ) class Schema(SchemaNode): diff --git a/docs/api.rst b/docs/api.rst index e80abec..947f0c2 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -115,8 +115,9 @@ Types Schema-Related ~~~~~~~~~~~~~~ - .. autoclass:: _SchemaNode + .. autoclass:: SchemaNode :members: + :inherited-members: .. automethod:: __delitem__ @@ -124,10 +125,6 @@ Schema-Related .. automethod:: __iter__ - .. autoclass:: SchemaNode - :show-inheritance: - :members: - .. autoclass:: Schema .. autoclass:: MappingSchema