docs/README.md · Idris-dev

git.iko.soy/Idris-dev

51 lines 1.6 kB history raw

1# Documentation for the Idris Language.

4This manual has been prepared using ReStructured Text and the [Sphinx Documentation Generator](http://sphinx-doc.org) for future inclusion on [Read The Docs](http://www.readthedocs.org).

6## Dependencies

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

10### Sphinx-Doc

12Python should be installed by default on most systems.

13Sphinx can be installed either through your hosts package manager or using pip/easy_install.

15*Note* [ReadTheDocs](http://www.readthedocs.org) works with Sphinx

16 `v1.2.2`. If you install a more recent version of sphinx then

17 'incorrectly' marked up documentation may get passed the build system

18 of readthedocs and be ignored. In the past we had several code-blocks

19 disappear because of that.

21The ReadTheDocs theme can be installed using pip as follows:

23```sh

24pip install sphinx_rtd_theme

25```

27### LaTeX

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

32## Build Instructions

34```sh

35make html

36make latexpdf

37```

39## Contributing

41The documentation for Idris has been published under the Creative

42Commons CC0 License. As such to the extent possible under law, /The

43Idris Community/ has waived all copyright and related or neighboring

44rights to Documentation for Idris.

46More information concerning the CC0 can be found online at:

48 http://creativecommons.org/publicdomain/zero/1.0/

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