diff options
| author |   Jim Hahn <jrh3@att.com> | 2020-10-16 14:17:43 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2020-10-16 14:17:43 +0000 |
| commit | 5190c58837149c4599182d211d8ae5bd83003d34 (patch) | |
| tree | 6186091f088a43623a2b9ebf9b203fc33e90825a /src/site-docs/adoc/fragments/howto-build/documentation.adoc | |
| parent | c293413c1c46d3c59ff8a855d683f4614bbe644a (diff) | |
| parent | 0cf967c0239a8ab9c8b8831b700b72d9a08f7b03 (diff) | |
Merge "Remove apex asciidoc documents"
Diffstat (limited to 'src/site-docs/adoc/fragments/howto-build/documentation.adoc')
| -rw-r--r-- | src/site-docs/adoc/fragments/howto-build/documentation.adoc | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/src/site-docs/adoc/fragments/howto-build/documentation.adoc b/src/site-docs/adoc/fragments/howto-build/documentation.adoc deleted file mode 100644 index 3a42cc78b..000000000 --- a/src/site-docs/adoc/fragments/howto-build/documentation.adoc +++ /dev/null @@ -1,41 +0,0 @@ -// -// ============LICENSE_START======================================================= -// Copyright (C) 2016-2018 Ericsson. All rights reserved. -// ================================================================================ -// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE -// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode -// -// SPDX-License-Identifier: CC-BY-4.0 -// ============LICENSE_END========================================================= -// -// @author Sven van der Meer (sven.van.der.meer@ericsson.com) -// - -== Build the APEX Documentation - -The APEX Maven build also includes stand-alone documentations, such as the HowTo documents, the Installation Guide, and the User Manual. -Use Maven to build the APEX Documentation. -The Maven options `-N` prevents Maven to go through all APEX modules, which is not necessary for the documentation. -The final documents will be in `target/generated-docs` (Windows: `target\generated-docs`). -The __HTML__ documents are in the `html/` folder, the __PDF__ documents are in the `pdf/` folder. -Once the documentation is build, copy the __HTML__ and __PDF__ documents to a folder of choice - -[width="100%",options="header",cols="5a,5a"] -|==================== -| Unix, Cygwin | Windows -| -[source%nowrap,sh,numbered] ----- -# cd /usr/local/src/apex -# mvn clean generate-resources -N -DapexDocs ----- -| -[source%nowrap,bat,numbered] ----- ->c: ->cd \dev\apex ->mvn clean generate-resources -N -DapexDocs ----- -|==================== - - |