diff options
| author | Loïc Hoguin <[email protected]> | 2016-03-19 12:24:21 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2016-03-19 12:27:55 +0100 |
| commit | ac9a8b47531071cfa908b1538a5b26cbf6e16d9d (patch) | |
| tree | 2e6133f41a9d159b4367d42b5fad4565e1f1da31 /doc | |
| parent | 93ea0c34333d558102572d9a4d8bbec50abca329 (diff) | |
| parent | d00ebea70754735a3d4067599845dd4522cdc1b2 (diff) | |
| download | erlang.mk-ac9a8b47531071cfa908b1538a5b26cbf6e16d9d.tar.gz erlang.mk-ac9a8b47531071cfa908b1538a5b26cbf6e16d9d.tar.bz2 erlang.mk-ac9a8b47531071cfa908b1538a5b26cbf6e16d9d.zip | |
Merge branch 'doc_deps_local_rep' of https://github.com/ingwinlu/erlang.mk
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/guide/asciidoc.asciidoc | 7 | ||||
| -rw-r--r-- | doc/src/guide/contributing.asciidoc | 3 | ||||
| -rw-r--r-- | doc/src/guide/deps.asciidoc | 2 |
3 files changed, 10 insertions, 2 deletions
diff --git a/doc/src/guide/asciidoc.asciidoc b/doc/src/guide/asciidoc.asciidoc index 621f5b5..cc8336b 100644 --- a/doc/src/guide/asciidoc.asciidoc +++ b/doc/src/guide/asciidoc.asciidoc @@ -5,6 +5,13 @@ Erlang.mk provides rules for generating documentation from AsciiDoc files. It can automatically build a user guide PDF, chunked HTML documentation and Unix manual pages. +=== Requirements + +It is necessary to have http://asciidoc.org/[AsciiDoc], +http://xmlsoft.org/XSLT/xsltproc2.html[xsltproc] and +http://dblatex.sourceforge.net/[dblatex] installed on your +system for Erlang.mk to generate documentation from AsciiDoc sources. + === Writing AsciiDoc documentation http://asciidoc.org/[AsciiDoc] is a text document format for diff --git a/doc/src/guide/contributing.asciidoc b/doc/src/guide/contributing.asciidoc index 968ea3e..58e5de6 100644 --- a/doc/src/guide/contributing.asciidoc +++ b/doc/src/guide/contributing.asciidoc @@ -100,7 +100,8 @@ this is a bug. You can either open a ticket or send a pull request. To make sure that the documentation changes work, install -Asciidoc on your system and run `make docs`. +the listed xref:asciidoc[Requirements] on your system and +run `make docs`. === Feature requests diff --git a/doc/src/guide/deps.asciidoc b/doc/src/guide/deps.asciidoc index be7ed52..eb6f2f0 100644 --- a/doc/src/guide/deps.asciidoc +++ b/doc/src/guide/deps.asciidoc @@ -334,7 +334,7 @@ Erlang.mk will also export the `REBAR_DEPS_DIR` variable for compatibility with Rebar build tools, as long as they are recent enough. -=== Dependencies local to the repository +=== Many applications in one repository In addition to the dependencies that are fetched, Erlang.mk also allows you to have dependencies local to your repository. |