From 7e94b2c4ed9389126ce9b92561918ff1d99386b7 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Wed, 24 May 2017 13:44:24 -0400 Subject: [PATCH] A first iteration of the usage documentation. --- docs/docs/usage.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/docs/usage.rst diff --git a/docs/docs/usage.rst b/docs/docs/usage.rst new file mode 100644 index 0000000..a8e45e8 --- /dev/null +++ b/docs/docs/usage.rst @@ -0,0 +1,33 @@ +.. include:: ../global.rst + +Usage +===== + +|parso| works around grammars. You can simply create Python grammars by calling +``load_grammar``. Grammars (with a custom tokenizer and custom parser trees) +can also be created by directly instantiating ``Grammar``. More information +about the resulting objects can be found in the :ref:`parser tree documentation +`. + +.. automodule:: parso.grammar + :members: + :undoc-members: + + +Utility +------- + +.. autofunction:: parso.parse + +.. automodule:: parso.utils + :members: + :undoc-members: + + +Used By +------- + +- jedi_ (which is used by IPython and a lot of plugins). + + +.. _jedi: https://github.com/davidhalter/jedi