Idris2-boot/docs
Edwin Brady 736699c729 Better ambiguity resolution
Do two passes through delayed elaborators (it's impossible to predict
dependency order). Possibly this should keep going as long as it's
making progress? I'll consider that later.
2020-03-31 13:04:42 +01:00
..
app Ints in buffers are 32 bit 2020-03-27 20:54:39 +00:00
backends Minor documentation edits 2020-03-28 16:00:33 +00:00
faq Basic support for struct in FFI 2020-03-01 23:23:21 +00:00
ffi Small fixes in readline ffi tutorial 2020-03-03 23:35:19 +00:00
listing Update interpreter section of crash course 2020-02-25 21:49:26 +00:00
proofs various copyedits 2020-03-07 23:18:49 -05:00
reference Look under . for function name on lhs 2020-03-05 11:22:48 +00:00
tutorial Minor documentation edits 2020-03-28 16:00:33 +00:00
typedd Better ambiguity resolution 2020-03-31 13:04:42 +01:00
updates Note on %hint in documentation 2020-03-29 13:02:10 +01:00
conf.py Improve RTD config. 2019-07-31 14:07:16 +01:00
index.rst Better ambiguity resolution 2020-03-31 13:04:42 +01:00
LICENSE Use HTTPS instead of HTTP 2019-12-18 21:37:50 +01:00
make.bat Use HTTPS instead of HTTP 2019-12-18 21:37:50 +01:00
Makefile Use HTTPS instead of HTTP 2019-12-18 21:37:50 +01:00
README.md Use HTTPS instead of HTTP 2019-12-18 21:37:50 +01:00

Documentation for the Idris Language.

This manual has been prepared using ReStructured Text and the Sphinx Documentation Generator for future inclusion on Read The Docs.

Dependencies

To build the manual the following dependencies must be met. We assume that you have standard build automation tools already install i.e. make.

Sphinx-Doc

Python should be installed by default on most systems. Sphinx can be installed either through your hosts package manager or using pip/easy_install.

Note ReadTheDocs works with Sphinx v1.2.2. If you install a more recent version of sphinx then 'incorrectly' marked up documentation may get passed the build system of readthedocs and be ignored. In the past we had several code-blocks disappear because of that.

The ReadTheDocs theme can be installed using pip as follows:

pip install sphinx_rtd_theme

LaTeX

LaTeX can be install either using your systems package manager or direct from TeXLive.

Build Instructions

make html
make latexpdf

Contributing

The documentation for Idris 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/

When contributing material to the manual please bear in mind that the work will be licensed as above.