From 92b54aacc0de5446dd5497c39897b0bbff72e626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 13 Jun 2018 09:54:12 +0200 Subject: Rebuild using Asciideck --- docs/en/erlang.mk/1/guide/asciidoc/index.html | 107 +++++++++----------------- 1 file changed, 35 insertions(+), 72 deletions(-) (limited to 'docs/en/erlang.mk/1/guide/asciidoc/index.html') diff --git a/docs/en/erlang.mk/1/guide/asciidoc/index.html b/docs/en/erlang.mk/1/guide/asciidoc/index.html index bb13a400..530c81cc 100644 --- a/docs/en/erlang.mk/1/guide/asciidoc/index.html +++ b/docs/en/erlang.mk/1/guide/asciidoc/index.html @@ -62,100 +62,63 @@

AsciiDoc documentation

-

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.

-
+

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 AsciiDoc, -xsltproc and -dblatex installed on your -system for Erlang.mk to generate documentation from AsciiDoc sources.

-
-
-
+

It is necessary to have AsciiDoc, xsltproc and dblatex installed on your system for Erlang.mk to generate documentation from AsciiDoc sources.

Writing AsciiDoc documentation

-
-

AsciiDoc is a text document format for -writing notes, documentation, articles, books, ebooks, slideshows, -web pages, man pages and blogs. AsciiDoc files can be translated -to many formats including HTML, PDF, EPUB, man page.

-

The AsciiDoc user guide -describes the AsciiDoc syntax.

-

The Erlang.mk user guide -is written in AsciiDoc and can be used as an example. The entry -file is book.asciidoc.

-

Erlang.mk expects you to put your documentation in a specific -location. This is doc/src/guide/ for the user guide, and -doc/src/manual/ for the function reference. In the case of -the user guide, the entry point is always doc/src/guide/book.asciidoc.

-

For manual pages, it is good practice to use section 3 for -modules, and section 7 for the application itself.

-
-
-
+

AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.

+

The AsciiDoc user guide describes the AsciiDoc syntax.

+

The Erlang.mk user guide is written in AsciiDoc and can be used as an example. The entry file is book.asciidoc.

+

Erlang.mk expects you to put your documentation in a specific location. This is doc/src/guide/ for the user guide, and doc/src/manual/ for the function reference. In the case of the user guide, the entry point is always doc/src/guide/book.asciidoc.

+

For manual pages, it is good practice to use section 3 for modules, and section 7 for the application itself.

Configuration

-
-

All of the AsciiDoc related configuration can be done directly -inside the files themselves.

-
-
-
+

All of the AsciiDoc related configuration can be done directly inside the files themselves.

Usage

-
-

To build all documentation:

-
-
-
$ make docs
-

To build only the AsciiDoc documentation:

-
-
-
$ make asciidoc
-

To build only the user guide:

-
-
-
$ make asciidoc-guide
-

To build only the manual:

-
-
-
$ make asciidoc-manual
-

To install man pages on Unix:

-
-
-
$ make install-docs
-

Erlang.mk allows customizing the installation path and sections -of the man pages to be installed. The MAN_INSTALL_PATH variable -defines where man pages will be installed. It defaults to -/usr/local/share/man. The MAN_SECTIONS variable defines -which manual sections are to be installed. It defaults to 3 7.

-

To install man pages to a custom location:

-
-
-
$ make install-docs MAN_INSTALL_PATH=/opt/share/man
-

Note that you may need to run the install commands using -sudo or equivalent if the location is not writeable by -your user.

-
-
+
$ make install-docs MAN_INSTALL_PATH=/opt/share/man
+ +

Note that you may need to run the install commands using sudo or equivalent if the location is not writeable by your user.

+ -- cgit v1.2.3