dbdf7dab3d
Following a fairly detailed discussion on slack, the feeling is generally that it's better to have a single interface. While precision is nice, it doesn't appear to buy us anything here. If that turns out to be wrong, or limiting somehow, we can revisit it later. Also: - it's easier for backend authors if the type of IO operations is slightly less restrictive. For example, if it's in HasIO, that limits alternative implementations, which might be awkward for some alternative back ends. - it's one less extra detail to learn. This is minor, but there needs to be a clear advantage if there's more detail to learn. - It is difficult to think of an underlying type that can't have a Monad instance (I have personally never encountered one - if they turns out to exist, again, we can revisit!) |
||
|---|---|---|
| .. | ||
| source | ||
| LICENSE | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
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. Recommended way is to use virtual environment for building documentation.
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 in virtual environment using pip as follows:
python3 -m venv idris2docs_venv
source idris2docs_venv/bin/activate
pip install --upgrade pip
pip install sphinx_rtd_theme
LaTeX
LaTeX can be install either using your systems package manager or direct from TeXLive.
Build Instructions
cd docs
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.