mirror of
https://github.com/davidhalter/parso.git
synced 2025-12-08 05:34:51 +08:00
A first iteration of the usage documentation.
This commit is contained in:
33
docs/docs/usage.rst
Normal file
33
docs/docs/usage.rst
Normal file
@@ -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
|
||||||
|
<plugin-api-classes>`.
|
||||||
|
|
||||||
|
.. 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
|
||||||
Reference in New Issue
Block a user