Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
eerimoq committed Jul 29, 2018
1 parent 2dc275b commit 0d596cf
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@ Text parser

.. include:: ../README.rst

Functions and classes
=====================
The parser class
================

.. autoclass:: textparser.Parser
:members:

Building the grammar
====================

The grammar built by combining the classes below and strings.

.. autoclass:: textparser.Sequence
:members:

Expand Down Expand Up @@ -64,6 +69,9 @@ Functions and classes
.. autoclass:: textparser.Pattern
:members:

Exceptions
==========

.. autoclass:: textparser.ParseError
:members:

Expand All @@ -73,6 +81,9 @@ Functions and classes
.. autoclass:: textparser.GrammarError
:members:

Utility functions
=================

.. autofunction:: textparser.markup_line

.. autofunction:: textparser.tokenize_init

0 comments on commit 0d596cf

Please sign in to comment.