xonsh/docs/api/index.rst

.. _api:

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

**Xonsh Standard Library:**

.. toctree::
    :maxdepth: 2

    lib/index


**Language:**

.. toctree::
    :maxdepth: 1

    lexer
    parser
    ast
    execer
    imphooks


**Command Prompt:**

.. toctree::
    :maxdepth: 1

    built_ins
    environ
    aliases
    dirstack
    jobs
    procs/index
    inspectors
    history/index
    completer
    completers/index
    prompt/index
    shell
    base_shell
    readline_shell
    ptk_shell/shell
    ptk_shell/history
    ptk_shell/completer
    ptk_shell/key_bindings
    pretty
    diff_history
    xoreutils/index


**Helpers:**

.. toctree::
    :maxdepth: 1

    events
    tools
    platform
    jsonutils
    lazyjson
    lazyasd
    openpy
    foreign_shells
    commands_cache
    tracer
    main
    color_tools
    pyghooks
    jupyter_kernel
    jupyter_shell
    dumb_shell
    wizard
    xonfig
    xontribs_meta
    codecache
    contexts


**Xontribs:**

.. toctree::
    :maxdepth: 1
    mplhooks
    vox
some doc updates 2015-03-07 19:30:06 -06:00			`.. _api:`

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

some doc fixes 2018-07-19 19:59:07 -04:00			`Xonsh Standard Library:`

			`.. toctree::`
			`:maxdepth: 2`

			`lib/index`


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`
Procs Initial Refactor (#3897) * refectored builtins * refectored posix and readers * refectored posix and readers * proxies * pipelines * basic procs import cleanup * fixed / refactored tests * procs docs * amalgamate * XONSH_DEBUG=1 in tests * exclude xonsh.procs mypy * Use `pip install` instead of `python setup.py install` * Update docs/api/procs/pipelines.rst Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com> Co-authored-by: Gil Forsyth <gil@forsyth.dev> Co-authored-by: Gil Forsyth <gforsyth@users.noreply.github.com> 2020-10-20 09:21:11 -05:00			`procs/index`
done with docs/api 2015-03-07 20:30:45 -06:00			`inspectors`
more doc fixes 2016-12-20 13:47:58 -08:00			`history/index`
done with docs/api 2015-03-07 20:30:45 -06:00			`completer`
add completer API doc hooks 2016-06-04 20:05:55 -04:00			`completers/index`
api docs for prompt 2016-09-04 19:59:48 +08:00			`prompt/index`
done with docs/api 2015-03-07 20:30:45 -06:00			`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`
Add ptk3 (#3521) * delete package ptk; rename ptk2 to ptk_shell.; leave ptk2 as alias for ptk_shell. * SHELL_TYPE "prompt_toolkit" only; remove ptk1 specific behavior. * Doc updates: eliminate reference to prompt-toolkit < 2.0 * update requirements files ptk>=2; test shell_style="none" * fix ptk2 stub per code review * Add ptk2 to list of packages to install. 2020-04-18 10:44:27 -04:00			`ptk_shell/shell`
			`ptk_shell/history`
			`ptk_shell/completer`
			`ptk_shell/key_bindings`
Added the pretty module to the documentation 2015-07-16 12:39:23 +02:00			`pretty`
started history differ 2015-08-23 22:57:36 -04:00			`diff_history`
audodoc hooks 2017-02-12 18:36:50 -05:00			`xoreutils/index`
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`

Add module API docs 2016-08-27 23:00:50 -04:00			`events`
some doc updates 2015-03-07 19:30:06 -06:00			`tools`
Adds a xonsh.platform module comes with occasional code cleanup and micro optimizations fixes `xonsh.tools.CommandCache.all_commands` 2016-05-15 21:59:28 +02:00			`platform`
New JSON utils module 2017-02-26 15:42:36 -05:00			`jsonutils`
more docs 2015-05-03 20:09:26 -05:00			`lazyjson`
more doc hooks 2016-06-25 12:52:05 -04:00			`lazyasd`
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`
minor doc fixes 2016-06-24 14:20:37 -04:00			`commands_cache`
added tracer mod 2016-02-05 01:45:05 -05:00			`tracer`
some doc updates 2015-03-07 19:30:06 -06:00			`main`
added news and docs 2017-02-21 00:15:34 -05:00			`color_tools`
recursive impl 2015-03-31 01:10:19 -05:00			`pyghooks`
docs for jupyter kernel 2015-10-04 15:00:00 -04:00			`jupyter_kernel`
add the jupyter_shell to the index 2018-08-02 23:49:55 -04:00			`jupyter_shell`
dumb terminal support 2018-12-13 16:02:59 -05:00			`dumb_shell`
autogen config var docs 2016-01-06 01:55:40 -08:00			`wizard`
			`xonfig`
refactor: replace xontribs.json with xontribs_meta.py closes #3931 2020-11-10 11:09:56 +05:30			`xontribs_meta`
documentation 2016-03-27 06:39:24 -04:00			`codecache`
even more docs 2016-06-05 22:41:56 -04:00			`contexts`
added tracer mod 2016-02-05 01:45:05 -05:00
interim add 2016-05-11 00:42:36 -04:00
			`Xontribs:`

			`.. toctree::`
			`:maxdepth: 1`
			`mplhooks`
Some corrections to vox-related documentation 2016-07-21 00:44:10 -04:00			`vox`