hy/docs/index.rst

The Hy Manual
=============

.. image:: _static/hy-logo-small.png
   :alt: Hy
   :align: left

:PyPI: https://pypi.python.org/pypi/hy
:Source: https://github.com/hylang/hy
:List: `hylang-discuss <https://groups.google.com/forum/#!forum/hylang-discuss>`_
:IRC: irc://chat.freenode.net/hy
:Stack Overflow: `The [hy] tag <https://stackoverflow.com/questions/tagged/hy>`_

Hy is a Lisp dialect that's embedded in Python. Since Hy transforms its Lisp
code into Python abstract syntax tree (AST) objects, you have the whole
beautiful world of Python at your fingertips, in Lisp form.

To install the latest stable release of Hy, just use the command ``pip3 install
--user hy``. Then you can start an interactive read-eval-print loop (REPL) with
the command ``hy``, or run a Hy program with ``hy myprogram.hy``.

.. toctree::
   :maxdepth: 3

   whyhy
   tutorial
   style-guide
   language/index
   extra/index
   contrib/index
   hacking
Overhaul introductory documentation - Removed links to non-updated code and badges. - Compressed `quickstart.rst` into a few sentences at the very start of the docs. - Added a "Why Hy?" chapter discussing Hy's features and comparing Hy to Python and other Lisps. - Rewrote the tutorial to be more accessible to non-Python programmers and to be greater in breadth but lesser in depth. - Cut down on the self-congratulatory manic tone and exclamation points, while keeping the jokes I liked best. 2019-08-19 14:00:53 -04:00			`The Hy Manual`
			`=============`
Adding in a docs directory. 2013-03-12 22:53:45 -04:00
Reorganize documentation. 2014-01-25 21:01:16 +02:00			`.. image:: _static/hy-logo-small.png`
			`:alt: Hy`
Replacing cuddles ascii art with the cuddles drawing, restoring hy logo 2013-05-20 18:17:11 -05:00			`:align: left`
Add hy logo to frontpage of docs 2013-04-03 11:27:40 -05:00
Reorganize documentation. 2014-01-25 21:01:16 +02:00			`:PyPI: https://pypi.python.org/pypi/hy`
			`:Source: https://github.com/hylang/hy`
			:List: `hylang-discuss <https://groups.google.com/forum/#!forum/hylang-discuss>`_
Overhaul introductory documentation - Removed links to non-updated code and badges. - Compressed `quickstart.rst` into a few sentences at the very start of the docs. - Added a "Why Hy?" chapter discussing Hy's features and comparing Hy to Python and other Lisps. - Rewrote the tutorial to be more accessible to non-Python programmers and to be greater in breadth but lesser in depth. - Cut down on the self-congratulatory manic tone and exclamation points, while keeping the jokes I liked best. 2019-08-19 14:00:53 -04:00			`:IRC: irc://chat.freenode.net/hy`
Advertise our Stack Overflow tag 2019-09-11 10:24:03 -04:00			:Stack Overflow: `The [hy] tag <https://stackoverflow.com/questions/tagged/hy>`_
Replacing cuddles ascii art with the cuddles drawing, restoring hy logo 2013-05-20 18:17:11 -05:00
Overhaul introductory documentation - Removed links to non-updated code and badges. - Compressed `quickstart.rst` into a few sentences at the very start of the docs. - Added a "Why Hy?" chapter discussing Hy's features and comparing Hy to Python and other Lisps. - Rewrote the tutorial to be more accessible to non-Python programmers and to be greater in breadth but lesser in depth. - Cut down on the self-congratulatory manic tone and exclamation points, while keeping the jokes I liked best. 2019-08-19 14:00:53 -04:00			`Hy is a Lisp dialect that's embedded in Python. Since Hy transforms its Lisp`
			`code into Python abstract syntax tree (AST) objects, you have the whole`
			`beautiful world of Python at your fingertips, in Lisp form.`
Adds try-hy to the docs As requested in PR #350. This commit also adds Joe "rahmu" Hakim Rahme to the AUTHORS file 2013-12-03 09:51:51 +01:00
Overhaul introductory documentation - Removed links to non-updated code and badges. - Compressed `quickstart.rst` into a few sentences at the very start of the docs. - Added a "Why Hy?" chapter discussing Hy's features and comparing Hy to Python and other Lisps. - Rewrote the tutorial to be more accessible to non-Python programmers and to be greater in breadth but lesser in depth. - Cut down on the self-congratulatory manic tone and exclamation points, while keeping the jokes I liked best. 2019-08-19 14:00:53 -04:00			To install the latest stable release of Hy, just use the command ``pip3 install
			--user hy``. Then you can start an interactive read-eval-print loop (REPL) with
			the command ``hy``, or run a Hy program with ``hy myprogram.hy``.
Adding in a docs directory. 2013-03-12 22:53:45 -04:00
Adding in docz 2013-03-13 19:43:19 -04:00			`.. toctree::`
			`:maxdepth: 3`
Adding in a docs directory. 2013-03-12 22:53:45 -04:00
Overhaul introductory documentation - Removed links to non-updated code and badges. - Compressed `quickstart.rst` into a few sentences at the very start of the docs. - Added a "Why Hy?" chapter discussing Hy's features and comparing Hy to Python and other Lisps. - Rewrote the tutorial to be more accessible to non-Python programmers and to be greater in breadth but lesser in depth. - Cut down on the self-congratulatory manic tone and exclamation points, while keeping the jokes I liked best. 2019-08-19 14:00:53 -04:00			`whyhy`
Addining some initial docs. 2013-04-07 11:35:10 -04:00			`tutorial`
Transplant style guide from hylang/hy-style-guide 2015-01-02 19:56:07 -08:00			`style-guide`
Addining some initial docs. 2013-04-07 11:35:10 -04:00			`language/index`
Add hy.extra 2016-12-26 14:41:08 -08:00			`extra/index`
Add documentation and doc strings 2013-11-29 19:59:20 -05:00			`contrib/index`
Reorganize documentation. 2014-01-25 21:01:16 +02:00			`hacking`