Public facing node documentation

7 files changed, 399 insertions, 1 deletions

diff --git a/doc/api/astroid.exceptions.rst b/doc/api/astroid.exceptions.rst
new file mode 100644
index 00000000..ede67432
--- /dev/null
+++ b/doc/api/astroid.exceptions.rst
@@ -0,0 +1,38 @@
+:mod:`astroid.exceptions`
+=========================
+
+.. automodule:: astroid.exceptions
+
+   .. rubric:: Classes
+
+   .. autosummary::
+
+      BinaryOperationError
+      OperationError
+      UnaryOperationError
+
+   .. rubric:: Exceptions
+
+   .. autosummary::
+
+      AstroidBuildingError
+      AstroidBuildingException
+      AstroidError
+      AstroidImportError
+      AstroidIndexError
+      AstroidSyntaxError
+      AstroidTypeError
+      AttributeInferenceError
+      DuplicateBasesError
+      InconsistentMroError
+      InferenceError
+      MroError
+      NameInferenceError
+      NoDefault
+      NotFoundError
+      ResolveError
+      SuperArgumentTypeError
+      SuperError
+      TooManyLevelsError
+      UnresolvableName
+      UseInferenceDefault
diff --git a/doc/api/astroid.nodes.rst b/doc/api/astroid.nodes.rst
new file mode 100644
index 00000000..84ceba98
--- /dev/null
+++ b/doc/api/astroid.nodes.rst
@@ -0,0 +1,226 @@
+:mod:`astroid.nodes`
+====================
+
+.. automodule:: astroid.nodes
+
+For a list of available nodes see :ref:`nodes`.
+
+.. _nodes:
+
+Nodes
+-----
+.. autosummary::
+
+   AnnAssign
+   Arguments
+   Assert
+   Assign
+   AssignAttr
+   AssignName
+   AsyncFor
+   AsyncFunctionDef
+   AsyncWith
+   Attribute
+   AugAssign
+   Await
+   BinOp
+   BoolOp
+   Break
+   Call
+   ClassDef
+   Compare
+   Comprehension
+   Const
+   Continue
+   Decorators
+   DelAttr
+   DelName
+   Delete
+   Dict
+   DictComp
+   DictUnpack
+   Ellipsis
+   EmptyNode
+   ExceptHandler
+   Exec
+   Expr
+   ExtSlice
+   For
+   FormattedValue
+   FunctionDef
+   GeneratorExp
+   Global
+   If
+   IfExp
+   Import
+   ImportFrom
+   Index
+   JoinedStr
+   Keyword
+   Lambda
+   List
+   ListComp
+   Module
+   Name
+   Nonlocal
+   Pass
+   Print
+   Raise
+   Repr
+   Return
+   Set
+   SetComp
+   Slice
+   Starred
+   Subscript
+   TryExcept
+   TryFinally
+   Tuple
+   UnaryOp
+   Unknown
+   While
+   With
+   Yield
+   YieldFrom
+
+.. autoclass:: AnnAssign
+
+.. autoclass:: Arguments
+
+.. autoclass:: Assert
+
+.. autoclass:: Assign
+
+.. autoclass:: AssignAttr
+
+.. autoclass:: AssignName
+
+.. autoclass:: AsyncFor
+
+.. autoclass:: AsyncFunctionDef
+
+.. autoclass:: AsyncWith
+
+.. autoclass:: Attribute
+
+.. autoclass:: AugAssign
+
+.. autoclass:: Await
+
+.. autoclass:: BinOp
+
+.. autoclass:: BoolOp
+
+.. autoclass:: Break
+
+.. autoclass:: Call
+
+.. autoclass:: ClassDef
+
+.. autoclass:: Compare
+
+.. autoclass:: Comprehension
+
+.. autoclass:: Const
+
+.. autoclass:: Continue
+
+.. autoclass:: Decorators
+
+.. autoclass:: DelAttr
+
+.. autoclass:: DelName
+
+.. autoclass:: Delete
+
+.. autoclass:: Dict
+
+.. autoclass:: DictComp
+
+.. autoclass:: DictUnpack
+
+.. autoclass:: Ellipsis
+
+.. autoclass:: EmptyNode
+
+.. autoclass:: ExceptHandler
+
+.. autoclass:: Exec
+
+.. autoclass:: Expr
+
+.. autoclass:: ExtSlice
+
+.. autoclass:: For
+
+.. autoclass:: FormattedValue
+
+.. autoclass:: FunctionDef
+
+.. autoclass:: GeneratorExp
+
+.. autoclass:: Global
+
+.. autoclass:: If
+
+.. autoclass:: IfExp
+
+.. autoclass:: Import
+
+.. autoclass:: ImportFrom
+
+.. autoclass:: Index
+
+.. autoclass:: JoinedStr
+
+.. autoclass:: Keyword
+
+.. autoclass:: Lambda
+
+.. autoclass:: List
+
+.. autoclass:: ListComp
+
+.. autoclass:: Module
+
+.. autoclass:: Name
+
+.. autoclass:: Nonlocal
+
+.. autoclass:: Pass
+
+.. autoclass:: Print
+
+.. autoclass:: Raise
+
+.. autoclass:: Repr
+
+.. autoclass:: Return
+
+.. autoclass:: Set
+
+.. autoclass:: SetComp
+
+.. autoclass:: Slice
+
+.. autoclass:: Starred
+
+.. autoclass:: Subscript
+
+.. autoclass:: TryExcept
+
+.. autoclass:: TryFinally
+
+.. autoclass:: Tuple
+
+.. autoclass:: UnaryOp
+
+.. autoclass:: Unknown
+
+.. autoclass:: While
+
+.. autoclass:: With
+
+.. autoclass:: Yield
+
+.. autoclass:: YieldFrom
diff --git a/doc/api/astroid.rst b/doc/api/astroid.rst
new file mode 100644
index 00000000..fda60271
--- /dev/null
+++ b/doc/api/astroid.rst
@@ -0,0 +1,64 @@
+:mod:`astroid`
+==============
+
+.. automodule:: astroid
+
+Submodules
+----------
+.. autosummary::
+   :toctree:
+
+   astroid.exceptions
+   astroid.nodes
+
+Exceptions
+----------
+.. currentmodule:: astroid.exceptions
+
+.. autosummary::
+
+   AstroidBuildingError
+   AstroidBuildingException
+   AstroidError
+   AstroidImportError
+   AstroidIndexError
+   AstroidSyntaxError
+   AstroidTypeError
+   AttributeInferenceError
+   BinaryOperationError
+   DuplicateBasesError
+   InconsistentMroError
+   InferenceError
+   MroError
+   NameInferenceError
+   NoDefault
+   NotFoundError
+   OperationError
+   ResolveError
+   SuperArgumentTypeError
+   SuperError
+   TooManyLevelsError
+   UnaryOperationError
+   UnresolvableName
+   UseInferenceDefault
+
+.. currentmodule:: astroid
+
+.. data:: MANAGER
+
+   The manager for doing stuff.
+
+   :type: astroid.manager.AstroidManager
+
+
+.. autoclass:: Uninferable
+
+.. autofunction:: are_exclusive
+
+.. autofunction:: builtin_lookup
+
+.. autofunction:: extract_node
+
+.. autofunction:: parse
+
+.. autofunction:: unpack_infer
diff --git a/doc/api/base_nodes.rst b/doc/api/base_nodes.rst
new file mode 100644
index 00000000..b298caa8
--- /dev/null
+++ b/doc/api/base_nodes.rst
@@ -0,0 +1,44 @@
+Base Nodes
+==========
+
+These are abstract node classes that :ref:`other nodes <nodes>` inherit from.
+
+.. autosummary::
+
+   astroid.mixins.AssignTypeMixin
+   astroid.node_classes._BaseContainer
+   astroid.mixins.BlockRangeMixIn
+   astroid.scoped_nodes.ComprehensionScope
+   astroid.mixins.FilterStmtsMixin
+   astroid.mixins.ImportFromMixin
+   astroid.scoped_nodes._ListComp
+   astroid.scoped_nodes.LocalsDictNodeNG
+   astroid.node_classes.LookupMixIn
+   astroid.node_classes.NodeNG
+   astroid.mixins.ParentAssignTypeMixin
+   astroid.node_classes.Statement
+
+
+.. autoclass:: astroid.mixins.AssignTypeMixin
+
+.. autoclass:: astroid.node_classes._BaseContainer
+
+.. autoclass:: astroid.mixins.BlockRangeMixIn
+
+.. autoclass:: astroid.scoped_nodes.ComprehensionScope
+
+.. autoclass:: astroid.mixins.FilterStmtsMixin
+
+.. autoclass:: astroid.mixins.ImportFromMixin
+
+.. autoclass:: astroid.scoped_nodes._ListComp
+
+.. autoclass:: astroid.scoped_nodes.LocalsDictNodeNG
+
+.. autoclass:: astroid.node_classes.LookupMixIn
+
+.. autoclass:: astroid.node_classes.NodeNG
+
+.. autoclass:: astroid.mixins.ParentAssignTypeMixin
+
+.. autoclass:: astroid.node_classes.Statement
diff --git a/doc/ast_objects.inv b/doc/ast_objects.inv
new file mode 100644
index 00000000..15683ac4
--- /dev/null
+++ b/doc/ast_objects.inv
@@ -0,0 +1,11 @@
+# Sphinx inventory version 2
+# Project: Green Tree Snakes
+# Version: 1.0
+# The remainder of this file is compressed using zlib.
+x����n�8F�z
+��t�]f�)�4���tIK�M�"U�J�R��"��1�s/��_q�?^�-�/�ŝc��6�pO�S"a������ҥ����G
��)�9a=�,ܕԿ��fk,�'���xi�qX�+�E�������S��V�/Pq���% No\��,�K��fb���d�`��@C�Xa�Gk���pg$�
+��ԑ�y��!sd���+��9�K��7]�-��ζ�RX�p����H
+K�)9Are�&׈J/�~���B���k�d�$2���B��97��_�n�@�q�̑=�K��J6�„��U�X\���ET�v�ǽ��\���D��$��o��{cC5@�B�8e�M�	��f�/�k(]�u�^��P8�U#��
<�&�t��t��(P:nu����f���$��[W8��Y6��E[{4�g�#��'y@�'H.��-Gn��J�FTz+;a�
G'�ȃ�mÙ����w��

+�˔l��	Y+	�l��C{ˈJ/W�s��.�3Z���g�7eV���
+.����r�$[�Tܓ"|�y�
i��e%,yb�|\[i�˕�ȥC����p�٭j>��ZY����r/���skZ�ζ����f
z����Y��k��a���'{
n$��.=؝x��:܅W�g�b�^��%���dݕ߬;\�]Y����?(2���I�~&F&�\|	��B�Jla�\f�#��m��i�����Nhs�MXpV��v�J��N�|�7cQe2��[(����p�řwaF9�|��5
�|b�٨��l�ͼH}d1���\U�y�x�MY߇Ϩ�ǛC���_l+�1�ܪ:
+-��"*?M��7�������rc���)��Z���
�'�:�\l���O����,�v;�e?�Ѝ@�����yz�3�6B�i��v�d�b�=aK`z���ec�;���>>�*'�mN���Y����1�&��\���?��7,|��QM�V��wQ�
\ No newline at end of file
diff --git a/doc/conf.py b/doc/conf.py
index 4164f7df..e054073d 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -25,7 +25,14 @@ sys.path.insert(0, os.path.abspath('../../'))
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -219,3 +226,9 @@ man_pages = [
     ('index', 'astroid', u'Astroid Documentation',
      [u'Logilab, PyCQA and contributors'], 1)
 ]
+
+autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
+intersphinx_mapping = {
+    'green_tree_snakes':
+        ('http://greentreesnakes.readthedocs.io/en/latest/', 'ast_objects.inv'),
+}
diff --git a/doc/index.rst b/doc/index.rst
index 536a25dd..5a291900 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -21,6 +21,8 @@ Contents:
 
    extending
 
+   api/astroid.rst
+
 
 Indices and tables
 ==================