git.iko.soy/Idris-dev
on master help sign in
Merge pull request #3179 from jfdm/update-sphinx

Updated Sphinx Doc for Packages.

commit6bfcfbef7ee80eccd069674145169f55857ad1de authorJan de Muijnck-Hughes <jfdm@users.noreply.github.com> dateThu 19 May 2016, 10:48 (10 years ago) parent2cfcbcf008e0c6
2 files changed+8−4
compare with master
unifiedsplit
docs/reference/packages.rst+5−2 docs/tutorial/packages.rst+3−2
docs/reference/packages.rst+5−2
@@ -14,7 +14,8 @@ Package Descriptions
1414
1515A package description includes the following:
1616
17−+ A header, consisting of the keyword package followed by the package name.
17++ A header, consisting of the keyword package followed by the package
18+ name. Package names can be any valid Idris identifier.
1819+ Fields describing package contents, ``<field> = <value>``
1920
2021At least one field must be the modules field, where the value is a
@@ -39,7 +40,9 @@ Other common fields which may be present in an ``ipkg`` file are:
3940 directory.
4041
4142+ ``executable = <output>``, which takes the name of the executable
42− file to generate.
43+ file to generate. Executable names can be any valid Idris
44+ identifier. the iPKG format also takes a quoted version that accepts
45+ any valid filename.
4346
4447+ ``main = <module>``, which takes the name of the main module, and
4548 must be present if the executable field is present.
docs/tutorial/packages.rst+3−2
@@ -4,14 +4,15 @@ Packages
44
55
66Idris includes a simple build system for building packages and executables from a named package description file.
7−These files can be used with the Idris compiler to manage the development process .
7+These files can be used with the Idris compiler to manage the development process.
88
99Package Descriptions
1010====================
1111
1212A package description includes the following:
1313
14−+ A header, consisting of the keyword package followed by the package name.
14++ A header, consisting of the keyword package followed by the package
15+ name. Package names can be any valid Idris identifier.
1516+ Fields describing package contents, ``<field> = <value>``
1617
1718At least one field must be the modules field, where the value is a