Skip to content

Commit

Permalink
Added internals section. (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahhhhmed committed Mar 21, 2018
1 parent fdd91e8 commit 8ad569c
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,47 @@ Running tests (run from the project root):

.. code-block:: bash
$python -m unittest
$python -m unittest
---------
Internals
---------

The code is separated in several components:

* `Parser`_
* `Syntax tree`_
* `Snippet provider`_
* `Utilities`_
* `Application frontend`_

Parser
^^^^^^

Responsible for converting snippet string to a syntax tree instance. Uses Ply_ to do the parsing.

Syntax tree
^^^^^^^^^^^

Tree structure of a snippet.

.. automodule:: homotopy.syntax_tree
:members:

Snippet provider
^^^^^^^^^^^^^^^^

Provides snippets definitions from a database of snippets.

Utilities
^^^^^^^^^

Utility functionality to help the development of editor add-ons.

Application frontend
^^^^^^^^^^^^^^^^^^^^

Console application frontend.

.. links
.. _Ply: http://www.dabeaz.com/ply/

0 comments on commit 8ad569c

Please sign in to comment.