Browse Source

Generate proper filenames in the docs' HTML output

This will allow to provide permanent URLs to the documentation.
Loïc Hoguin 9 years ago
parent
commit
be976cf37a

+ 1 - 0
doc/src/guide/app.asciidoc

@@ -1,3 +1,4 @@
+[[building]]
 == Building
 
 Erlang.mk can do a lot of things, but it is, first and

+ 1 - 0
doc/src/guide/asciidoc.asciidoc

@@ -1,3 +1,4 @@
+[[asciidoc]]
 == Asciidoc documentation
 
 // @todo Write it.

+ 6 - 0
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?]

+ 1 - 0
doc/src/guide/ci.asciidoc

@@ -1,3 +1,4 @@
+[[ci]]
 == Continuous integration
 
 // @todo Write it.

+ 1 - 0
doc/src/guide/common_test.asciidoc

@@ -1,3 +1,4 @@
+[[ct]]
 == Common Test
 
 Common Test is Erlang's functional testing framework.

+ 1 - 0
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

+ 1 - 0
doc/src/guide/contributing.asciidoc

@@ -1,3 +1,4 @@
+[[contributing]]
 == Contributing
 
 You are welcome and encouraged to contribute.

+ 1 - 0
doc/src/guide/coverage.asciidoc

@@ -1,3 +1,4 @@
+[[coverage]]
 == Code coverage
 
 // @todo Write it.

+ 1 - 0
doc/src/guide/deps.asciidoc

@@ -1,3 +1,4 @@
+[[deps]]
 == Packages and dependencies
 
 Erlang.mk can fetch and compile the dependencies that your

+ 1 - 0
doc/src/guide/dialyzer.asciidoc

@@ -1,3 +1,4 @@
+[[dialyzer]]
 == Dialyzer
 
 Dialyzer is a tool that will detect discrepancies in your

+ 1 - 0
doc/src/guide/edoc.asciidoc

@@ -1,3 +1,4 @@
+[[edoc]]
 == EDoc comments
 
 // @todo Write it.

+ 1 - 0
doc/src/guide/escripts.asciidoc

@@ -1,3 +1,4 @@
+[[escript]]
 == Escripts
 
 // @todo Write it.

+ 1 - 0
doc/src/guide/eunit.asciidoc

@@ -1,3 +1,4 @@
+[[eunit]]
 == EUnit
 
 EUnit is the tool of choice for unit testing. Erlang.mk

+ 1 - 0
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

+ 1 - 0
doc/src/guide/getting_started.asciidoc

@@ -1,3 +1,4 @@
+[[getting_started]]
 == Getting started
 
 This chapter explains how to get started using Erlang.mk.

+ 1 - 0
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

+ 1 - 0
doc/src/guide/installation.asciidoc

@@ -1,3 +1,4 @@
+[[installation]]
 == Installation
 
 This chapter explains how to setup your system in

+ 1 - 0
doc/src/guide/limitations.asciidoc

@@ -1,3 +1,4 @@
+[[limitations]]
 == Limitations
 
 No software is perfect.

+ 1 - 0
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

+ 1 - 0
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

+ 1 - 0
doc/src/guide/property_based_testing.asciidoc

@@ -1,3 +1,4 @@
+[[property_based_testing]]
 == Property based testing
 
 // @todo Write it.

+ 1 - 0
doc/src/guide/releases.asciidoc

@@ -1,3 +1,4 @@
+[[relx]]
 == Releases
 
 Erlang.mk relies on _Relx_ for generating releases. This

+ 1 - 0
doc/src/guide/shell.asciidoc

@@ -1,3 +1,4 @@
+[[shell]]
 == Erlang shell
 
 Erlang.mk provides a convenient target for starting a shell

+ 1 - 0
doc/src/guide/updating.asciidoc

@@ -1,3 +1,4 @@
+[[updating]]
 == Updating Erlang.mk
 
 This chapter describes how to update the 'erlang.mk' file

+ 1 - 0
doc/src/guide/why.asciidoc

@@ -1,3 +1,4 @@
+[[why]]
 == Why Erlang.mk
 
 Why would you choose Erlang.mk, if not for its

+ 1 - 0
doc/src/guide/xref.asciidoc

@@ -1,3 +1,4 @@
+[[xref]]
 == Xref
 
 // @todo Write it.