From a8ef9990b690838f97ff5a8e60088813ece4608d Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Wed, 24 May 2017 13:50:26 -0400 Subject: [PATCH] First iteration of parser tree docs. --- docs/docs/parser_tree.rst | 36 ++++++++++++++++++++++++++++++++++++ docs/docs/usage.rst | 8 ++++++++ 2 files changed, 44 insertions(+) create mode 100644 docs/docs/parser_tree.rst diff --git a/docs/docs/parser_tree.rst b/docs/docs/parser_tree.rst new file mode 100644 index 0000000..52ad8b7 --- /dev/null +++ b/docs/docs/parser_tree.rst @@ -0,0 +1,36 @@ +.. _parser-tree: + +Parser Tree +=========== + +Usage +----- + +.. automodule:: parso.python + :members: + :undoc-members: + + +Parser Tree Base Class +---------------------- + +All nodes and leaves have these methods/properties: + +.. autoclass:: parso.tree.NodeOrLeaf + :members: + :undoc-members: + + +Python Parser Tree +------------------ + +.. automodule:: parso.python.tree + :members: + :undoc-members: + :show-inheritance: + + +Utility +------- + +.. autofunction:: parso.tree.search_ancestor diff --git a/docs/docs/usage.rst b/docs/docs/usage.rst index a8e45e8..5697ff7 100644 --- a/docs/docs/usage.rst +++ b/docs/docs/usage.rst @@ -9,6 +9,14 @@ can also be created by directly instantiating ``Grammar``. More information about the resulting objects can be found in the :ref:`parser tree documentation `. +The simplest way of using parso is without even loading a grammar: + +.. sourcecode:: python + + >>> import parso + >>> parso.parse('foo + bar') + + .. automodule:: parso.grammar :members: :undoc-members: