xonsh/docs/dependencies.rst
Morten Enemark Lund 8b67a566a1 Change the structure of headings in docs
This makes the main page much more readable.
2019-10-07 22:24:32 +02:00

26 lines
1.1 KiB
ReStructuredText

Dependencies
------------
Xonsh currently has the following external dependencies,
*Run Time:*
#. Python v3.4+
Pip supports "extra" dependencies in the form of ``xonsh[ptk,linux]``, where
the list in the brackets identify the optional features
Xonsh currently has the following extras
#. ``ptk``: prompt-toolkit:
*advanced readline library, line-editing*
#. ``pygments>=2.2``: *syntax-highlighting*
#. ``proctitle``: setproctitle: *change the title of terminal to reflect the current subprocess*
#. ``linux``: distro: *linux specific platform information*
#. ``mac``: gnureadline: *GNU's featureful version of readline*
In addition, xonsh integrates with Jupyter, an in-browser REPL, enabling the use of xonsh in jupyter notebooks
Development Dependencies
------------------------
If you want to develop xonsh, it is extremely recommended to install the dependencies listed in `requirements/docs.txt <https://github.com/xonsh/xonsh/blob/master/requirements/docs.txt>`_ (to generate documentation) and `requirements/tests.txt <https://github.com/xonsh/xonsh/blob/master/requirements/tests.txt>`_ (to run the test suite).