Idris2-boot/docs/index.rst

.. Idris Manual documentation master file, created by
   sphinx-quickstart on Sat Feb 28 20:41:47 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Documentation for the Idris 2 Language
======================================

.. note::

   The documentation for Idris 2 has been published under the Creative
   Commons CC0 License. As such to the extent possible under law, *The
   Idris Community* has waived all copyright and related or neighboring
   rights to Documentation for Idris.

   More information concerning the CC0 can be found online at: https://creativecommons.org/publicdomain/zero/1.0/

This is still a work in progress; many details are copied directly from the
`Idris 1 tutorial <https://idris.readthedocs.org>`_
and yet to be updated, so use with caution!

.. toctree::
   :maxdepth: 1

   tutorial/index
   updates/updates
   typedd/typedd
   app/index
   ffi/ffi
   proofs/index
   faq/faq
   reference/index
Add template for readthedocs 2019-07-21 16:45:12 +03:00			`.. Idris Manual documentation master file, created by`
			`sphinx-quickstart on Sat Feb 28 20:41:47 2015.`
			`You can adapt this file completely to your liking, but it should at least`
			contain the root `toctree` directive.

			`Documentation for the Idris 2 Language`
			`======================================`

			`.. note::`

			`The documentation for Idris 2 has been published under the Creative`
			`Commons CC0 License. As such to the extent possible under law, *The`
			`Idris Community* has waived all copyright and related or neighboring`
			`rights to Documentation for Idris.`

Use HTTPS instead of HTTP 2019-12-18 23:37:50 +03:00			`More information concerning the CC0 can be found online at: https://creativecommons.org/publicdomain/zero/1.0/`
Add template for readthedocs 2019-07-21 16:45:12 +03:00
Copy some docs over from Idris 1 These are still to be updated (as noted in the files), but it needs doing before any kind of preliminary release. Plan is to refresh the tutorial and make sure samples work again, then write a more comprehensive document explaining changes since Idris 1. 2020-02-24 13:08:10 +03:00			`This is still a work in progress; many details are copied directly from the`
			`Idris 1 tutorial <https://idris.readthedocs.org>`_
			`and yet to be updated, so use with caution!`
Add template for readthedocs 2019-07-21 16:45:12 +03:00
			`.. toctree::`
			`:maxdepth: 1`

Copy some docs over from Idris 1 These are still to be updated (as noted in the files), but it needs doing before any kind of preliminary release. Plan is to refresh the tutorial and make sure samples work again, then write a more comprehensive document explaining changes since Idris 1. 2020-02-24 13:08:10 +03:00			`tutorial/index`
			`updates/updates`
Some documentation on changes since Idris 1 2020-02-26 23:19:54 +03:00			`typedd/typedd`
Small documentation updates 2020-02-28 03:15:03 +03:00			`app/index`
Basic support for struct in FFI Just in the Chez backend for now, and not allowing strings or functions due to limitations of Chez. 2020-03-02 02:23:21 +03:00			`ffi/ffi`
More documentation refreshing 2020-02-26 01:18:02 +03:00			`proofs/index`
Add template for readthedocs 2019-07-21 16:45:12 +03:00			`faq/faq`
Add documentation for Idris Packages. This is an initial copy and refinement of the existing documentation for packaging. This commit also starts the Idris2 reference documentation, in which we can start documenting the language proper. Maybe we should include the contents of `Notes` here, but that is a question for later. 2019-07-31 16:12:31 +03:00			`reference/index`