xonsh/docs/api/index.rst

.. _api:

=================
Xonsh API
=================
For those of you who want the gritty details.

**Language:**

.. toctree::
    :maxdepth: 1

    lexer
    parser
    ast
    execer
    imphooks


**Command Prompt:**

.. toctree::
    :maxdepth: 1

    built_ins
    environ
    aliases
    dirstack
    jobs
    proc
    inspectors
    history
    completer
    shell
    base_shell
    readline_shell
    prompt_toolkit_shell
    prompt_toolkit_completer
    prompt_toolkit_history
    pretty
    replay
    diff_history


**Helpers:**

.. toctree::
    :maxdepth: 1

    tools
    lazyjson
    teepty
    openpy
    foreign_shells
    main
    pyghooks
some doc updates 2015-03-07 19:30:06 -06:00			`.. _api:`

			`=================`
			`Xonsh API`
			`=================`
			`For those of you who want the gritty details.`

more edits 2015-03-07 19:53:41 -06:00			`Language:`

			`.. toctree::`
			`:maxdepth: 1`

			`lexer`
language api docs 2015-03-07 20:11:33 -06:00			`parser`
			`ast`
			`execer`
import hooks docs 2015-03-30 00:11:37 -05:00			`imphooks`
more edits 2015-03-07 19:53:41 -06:00

more autodoc hooks 2015-03-07 20:24:07 -06:00			`Command Prompt:`

			`.. toctree::`
			`:maxdepth: 1`

			`built_ins`
			`environ`
			`aliases`
documentation for dirstack module 2015-03-21 20:01:10 -04:00			`dirstack`
job control: documentation 2015-03-27 02:07:17 -04:00			`jobs`
documentation for ProcProxy 2015-05-12 19:26:27 -04:00			`proc`
done with docs/api 2015-03-07 20:30:45 -06:00			`inspectors`
added teepty 2015-08-23 14:09:10 -04:00			`history`
done with docs/api 2015-03-07 20:30:45 -06:00			`completer`
			`shell`
Add prompt_toolkit based shell. This adds prompt_toolkit based shell in addition to existing readline shell. By default regular readline shell is loaded, to use prompt_toolkit version you need to add: $PROMPT_TOOLKIT_SHELL = True to your ~/.xonshrc Another nice thing to add there is: from xonsh.pyghooks import XonshLexer $HIGHLIGHTING_LEXER = XonshLexer that adds highlighting of shell input (may be a bit annoying sometimes). There is no key for inserting indentation yet, it will be improved in the future. 2015-05-12 11:52:00 +02:00			`base_shell`
			`readline_shell`
			`prompt_toolkit_shell`
			`prompt_toolkit_completer`
Fix bugs in LimitedFileHistory (plus tests) and move it to different file. * Move LimitedFileHistory from history.py to prompt_toolkit_history.py because it is needed only for prompt_toolkit and requires prompt_toolkit. * Add instalation of prompt_toolkit to .travis.yml * Update docs hooks 2015-05-17 23:51:21 +02:00			`prompt_toolkit_history`
Added the pretty module to the documentation 2015-07-16 12:39:23 +02:00			`pretty`
inited replay 2015-08-23 14:13:14 -04:00			`replay`
started history differ 2015-08-23 22:57:36 -04:00			`diff_history`
more autodoc hooks 2015-03-07 20:24:07 -06:00

some doc updates 2015-03-07 19:30:06 -06:00			`Helpers:`

			`.. toctree::`
			`:maxdepth: 1`

			`tools`
more docs 2015-05-03 20:09:26 -05:00			`lazyjson`
added teepty 2015-08-23 14:09:10 -04:00			`teepty`
more autodoc hooks 2015-03-07 20:24:07 -06:00			`openpy`
minor fixes from review 2015-10-11 10:51:26 -04:00			`foreign_shells`
some doc updates 2015-03-07 19:30:06 -06:00			`main`
recursive impl 2015-03-31 01:10:19 -05:00			`pyghooks`