From be976cf37aff634fc9668e15e7a0b1adacf89595 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 29 Dec 2015 00:28:30 +0100 Subject: Generate proper filenames in the docs' HTML output This will allow to provide permanent URLs to the documentation. --- doc/src/guide/app.asciidoc | 1 + doc/src/guide/asciidoc.asciidoc | 1 + doc/src/guide/book.asciidoc | 6 ++++++ doc/src/guide/ci.asciidoc | 1 + doc/src/guide/common_test.asciidoc | 1 + doc/src/guide/compat.asciidoc | 1 + doc/src/guide/contributing.asciidoc | 1 + doc/src/guide/coverage.asciidoc | 1 + doc/src/guide/deps.asciidoc | 1 + doc/src/guide/dialyzer.asciidoc | 1 + doc/src/guide/edoc.asciidoc | 1 + doc/src/guide/escripts.asciidoc | 1 + doc/src/guide/eunit.asciidoc | 1 + doc/src/guide/external_plugins.asciidoc | 1 + doc/src/guide/getting_started.asciidoc | 1 + doc/src/guide/history.asciidoc | 1 + doc/src/guide/installation.asciidoc | 1 + doc/src/guide/limitations.asciidoc | 1 + doc/src/guide/overview.asciidoc | 1 + doc/src/guide/ports.asciidoc | 1 + doc/src/guide/property_based_testing.asciidoc | 1 + doc/src/guide/releases.asciidoc | 1 + doc/src/guide/shell.asciidoc | 1 + doc/src/guide/updating.asciidoc | 1 + doc/src/guide/why.asciidoc | 1 + doc/src/guide/xref.asciidoc | 1 + 26 files changed, 31 insertions(+) (limited to 'doc/src') diff --git a/doc/src/guide/app.asciidoc b/doc/src/guide/app.asciidoc index b2854de..eeb3018 100644 --- a/doc/src/guide/app.asciidoc +++ b/doc/src/guide/app.asciidoc @@ -1,3 +1,4 @@ +[[building]] == Building Erlang.mk can do a lot of things, but it is, first and diff --git a/doc/src/guide/asciidoc.asciidoc b/doc/src/guide/asciidoc.asciidoc index 6ba43ec..2fca131 100644 --- a/doc/src/guide/asciidoc.asciidoc +++ b/doc/src/guide/asciidoc.asciidoc @@ -1,3 +1,4 @@ +[[asciidoc]] == Asciidoc documentation // @todo Write it. diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc index 316df7f..d5d2dfc 100644 --- a/doc/src/guide/book.asciidoc +++ b/doc/src/guide/book.asciidoc @@ -1,4 +1,5 @@ // a2x: --dblatex-opts "-P latex.output.revhistory=0 -P doc.publisher.show=0 -P index.numbered=0" +// a2x: --xsltproc-opts "--stringparam use.id.as.filename 1" // a2x: -d book --attribute tabsize=4 = Erlang.mk User Guide @@ -14,6 +15,7 @@ include::updating.asciidoc[Updating Erlang.mk] include::limitations.asciidoc[Limitations] +[[code]] = Code include::app.asciidoc[Building] @@ -28,12 +30,14 @@ include::escripts.asciidoc[Escripts] include::compat.asciidoc[Compatibility with other build tools] +[[docs]] = Documentation include::asciidoc.asciidoc[Asciidoc documentation] include::edoc.asciidoc[EDoc comments] +[[tests]] = Tests include::shell.asciidoc[Erlang shell] @@ -52,10 +56,12 @@ include::dialyzer.asciidoc[Dialyzer] include::xref.asciidoc[Xref] +[[plugins]] = Third-party plugins include::external_plugins.asciidoc[External plugins] +[[about]] = About Erlang.mk include::why.asciidoc[Why erlang.mk?] diff --git a/doc/src/guide/ci.asciidoc b/doc/src/guide/ci.asciidoc index 8a96ed4..24cfc05 100644 --- a/doc/src/guide/ci.asciidoc +++ b/doc/src/guide/ci.asciidoc @@ -1,3 +1,4 @@ +[[ci]] == Continuous integration // @todo Write it. diff --git a/doc/src/guide/common_test.asciidoc b/doc/src/guide/common_test.asciidoc index 3f00baf..2ef1675 100644 --- a/doc/src/guide/common_test.asciidoc +++ b/doc/src/guide/common_test.asciidoc @@ -1,3 +1,4 @@ +[[ct]] == Common Test Common Test is Erlang's functional testing framework. diff --git a/doc/src/guide/compat.asciidoc b/doc/src/guide/compat.asciidoc index 61386e7..381e845 100644 --- a/doc/src/guide/compat.asciidoc +++ b/doc/src/guide/compat.asciidoc @@ -1,3 +1,4 @@ +[[compat]] == Compatibility with other build tools Erlang.mk tries its best to be compatible with the other Erlang diff --git a/doc/src/guide/contributing.asciidoc b/doc/src/guide/contributing.asciidoc index 0bb12a1..968ea3e 100644 --- a/doc/src/guide/contributing.asciidoc +++ b/doc/src/guide/contributing.asciidoc @@ -1,3 +1,4 @@ +[[contributing]] == Contributing You are welcome and encouraged to contribute. diff --git a/doc/src/guide/coverage.asciidoc b/doc/src/guide/coverage.asciidoc index 5e74f36..f33f878 100644 --- a/doc/src/guide/coverage.asciidoc +++ b/doc/src/guide/coverage.asciidoc @@ -1,3 +1,4 @@ +[[coverage]] == Code coverage // @todo Write it. diff --git a/doc/src/guide/deps.asciidoc b/doc/src/guide/deps.asciidoc index 9335439..9093d74 100644 --- a/doc/src/guide/deps.asciidoc +++ b/doc/src/guide/deps.asciidoc @@ -1,3 +1,4 @@ +[[deps]] == Packages and dependencies Erlang.mk can fetch and compile the dependencies that your diff --git a/doc/src/guide/dialyzer.asciidoc b/doc/src/guide/dialyzer.asciidoc index d58afbc..58fe53f 100644 --- a/doc/src/guide/dialyzer.asciidoc +++ b/doc/src/guide/dialyzer.asciidoc @@ -1,3 +1,4 @@ +[[dialyzer]] == Dialyzer Dialyzer is a tool that will detect discrepancies in your diff --git a/doc/src/guide/edoc.asciidoc b/doc/src/guide/edoc.asciidoc index f54d447..7827692 100644 --- a/doc/src/guide/edoc.asciidoc +++ b/doc/src/guide/edoc.asciidoc @@ -1,3 +1,4 @@ +[[edoc]] == EDoc comments // @todo Write it. diff --git a/doc/src/guide/escripts.asciidoc b/doc/src/guide/escripts.asciidoc index fcc6080..3d68c77 100644 --- a/doc/src/guide/escripts.asciidoc +++ b/doc/src/guide/escripts.asciidoc @@ -1,3 +1,4 @@ +[[escript]] == Escripts // @todo Write it. diff --git a/doc/src/guide/eunit.asciidoc b/doc/src/guide/eunit.asciidoc index 591d4c6..62188d9 100644 --- a/doc/src/guide/eunit.asciidoc +++ b/doc/src/guide/eunit.asciidoc @@ -1,3 +1,4 @@ +[[eunit]] == EUnit EUnit is the tool of choice for unit testing. Erlang.mk diff --git a/doc/src/guide/external_plugins.asciidoc b/doc/src/guide/external_plugins.asciidoc index 6f7acd5..d3dafaa 100644 --- a/doc/src/guide/external_plugins.asciidoc +++ b/doc/src/guide/external_plugins.asciidoc @@ -1,3 +1,4 @@ +[[plugins_usage]] == External plugins It is often convenient to be able to keep the build files diff --git a/doc/src/guide/getting_started.asciidoc b/doc/src/guide/getting_started.asciidoc index 71ec0cb..8a01ac0 100644 --- a/doc/src/guide/getting_started.asciidoc +++ b/doc/src/guide/getting_started.asciidoc @@ -1,3 +1,4 @@ +[[getting_started]] == Getting started This chapter explains how to get started using Erlang.mk. diff --git a/doc/src/guide/history.asciidoc b/doc/src/guide/history.asciidoc index 553a322..9202743 100644 --- a/doc/src/guide/history.asciidoc +++ b/doc/src/guide/history.asciidoc @@ -1,3 +1,4 @@ +[[history]] == Short history This chapter aims to be a brief record of the life of the diff --git a/doc/src/guide/installation.asciidoc b/doc/src/guide/installation.asciidoc index a271e2d..cc18e7f 100644 --- a/doc/src/guide/installation.asciidoc +++ b/doc/src/guide/installation.asciidoc @@ -1,3 +1,4 @@ +[[installation]] == Installation This chapter explains how to setup your system in diff --git a/doc/src/guide/limitations.asciidoc b/doc/src/guide/limitations.asciidoc index 86ca918..1bf33d2 100644 --- a/doc/src/guide/limitations.asciidoc +++ b/doc/src/guide/limitations.asciidoc @@ -1,3 +1,4 @@ +[[limitations]] == Limitations No software is perfect. diff --git a/doc/src/guide/overview.asciidoc b/doc/src/guide/overview.asciidoc index a81dd7a..fd62d0b 100644 --- a/doc/src/guide/overview.asciidoc +++ b/doc/src/guide/overview.asciidoc @@ -1,3 +1,4 @@ +[[overview]] == Overview Now that you know how to get started, let's take a look at diff --git a/doc/src/guide/ports.asciidoc b/doc/src/guide/ports.asciidoc index efe4ff7..02c636f 100644 --- a/doc/src/guide/ports.asciidoc +++ b/doc/src/guide/ports.asciidoc @@ -1,3 +1,4 @@ +[[ports]] == NIFs and port drivers Erlang.mk can not only build Erlang projects, but also the C code diff --git a/doc/src/guide/property_based_testing.asciidoc b/doc/src/guide/property_based_testing.asciidoc index c652b2b..0adacbd 100644 --- a/doc/src/guide/property_based_testing.asciidoc +++ b/doc/src/guide/property_based_testing.asciidoc @@ -1,3 +1,4 @@ +[[property_based_testing]] == Property based testing // @todo Write it. diff --git a/doc/src/guide/releases.asciidoc b/doc/src/guide/releases.asciidoc index e7b1333..46183e6 100644 --- a/doc/src/guide/releases.asciidoc +++ b/doc/src/guide/releases.asciidoc @@ -1,3 +1,4 @@ +[[relx]] == Releases Erlang.mk relies on _Relx_ for generating releases. This diff --git a/doc/src/guide/shell.asciidoc b/doc/src/guide/shell.asciidoc index 083c160..a527253 100644 --- a/doc/src/guide/shell.asciidoc +++ b/doc/src/guide/shell.asciidoc @@ -1,3 +1,4 @@ +[[shell]] == Erlang shell Erlang.mk provides a convenient target for starting a shell diff --git a/doc/src/guide/updating.asciidoc b/doc/src/guide/updating.asciidoc index ecd4a70..61d913d 100644 --- a/doc/src/guide/updating.asciidoc +++ b/doc/src/guide/updating.asciidoc @@ -1,3 +1,4 @@ +[[updating]] == Updating Erlang.mk This chapter describes how to update the 'erlang.mk' file diff --git a/doc/src/guide/why.asciidoc b/doc/src/guide/why.asciidoc index 3a84940..a48461b 100644 --- a/doc/src/guide/why.asciidoc +++ b/doc/src/guide/why.asciidoc @@ -1,3 +1,4 @@ +[[why]] == Why Erlang.mk Why would you choose Erlang.mk, if not for its diff --git a/doc/src/guide/xref.asciidoc b/doc/src/guide/xref.asciidoc index 889aa41..44ed190 100644 --- a/doc/src/guide/xref.asciidoc +++ b/doc/src/guide/xref.asciidoc @@ -1,3 +1,4 @@ +[[xref]] == Xref // @todo Write it. -- cgit v1.2.3