Skip to content

Commit

Permalink
Update makefile command
Browse files Browse the repository at this point in the history
  • Loading branch information
aremazeilles committed Oct 26, 2020
1 parent a6e8a3b commit 5a0163c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Distributed under the Non-Profit Open Software License 3.0 (NPOSL-3.0).

SILENT = @
ADOC_FILES = $(wildcard ./*.adoc)
ADOC_FILES = $(wildcard *.adoc modules/ROOT/pages/*.adoc)
HTML_FILES = $(subst .adoc,.html,$(ADOC_FILES))
all: $(HTML_FILES)

Expand Down
9 changes: 5 additions & 4 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ Antora requires 3 components:

* Components that contain the information to deploy.
That is this repository.
The structure of this repo is thus guided by Antora's requirements
The structure of this repo is thus guided by Antora's requirements.
* A UI themes which configures the graphical aspect of the website.
We use a fork of the default UI, located in the https://github.com/eurobench/antora_ui[Eurobench organization's github].
* A playbook that contains the configuration to be used by Antora to generate the static pages.
The one we used in stored in the https://github.com/eurobench/antora_playbook[Eurobench organization's github]
The one we used in stored in the https://github.com/eurobench/antora_playbook[Eurobench organization's github].

General information on the Antora concepts can be found https://matthewsetter.com/antora/three-core-concepts/[here].

Expand All @@ -48,11 +48,12 @@ All the deployment is then handled through the link:.github/workflows/build_depl

== Additional Tools

_TODO: To be revised_

To generate locally the documentation (under Linux), type from the repository root the command `make`.
It requires `make` and `asciidoctor` installed locally.

WARNING: Look for html pages in folder `modules/ROOT/pages`.
The link towards other pages may not be working locally.

---

[cols=".^30, .^80", grid=none,frame=none]
Expand Down

0 comments on commit 5a0163c

Please sign in to comment.