3ee965e30d
We had a lot of things missing here, and the contributing guidelines were extremely out of date and reflected the state when I first made the Idris 2 repo public. I've updated both to reflect the current state of the way we work, and to give better guidelines about what will be most helpful. |
||
|---|---|---|
| .. | ||
| source | ||
| LICENSE | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
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 installed 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 installed either using your systems package manager or directly 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.