Skip to content

Commit 4e59401

Browse files
committed
docs: antora playbooks refer to mrdocs repo
The previously had to still refer to the mrdox repository.
1 parent 2ac2157 commit 4e59401

4 files changed

+50
-10
lines changed

docs/antora-playbook.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
# npx antora --fetch antora-playbook.yml
33
site:
44
title: MrDocs
5-
url: https://cppalliance.github.io/mrdox/
6-
start_page: mrdox::index.adoc
5+
url: https://cppalliance.github.io/mrdocs/
6+
start_page: mrdocs::index.adoc
77
robots: allow
88
keys:
9-
repo_url: 'https://github.com/cppalliance/mrdox'
9+
repo_url: 'https://github.com/cppalliance/mrdocs'
1010

1111
content:
1212
branches: [ master, develop ]
1313
tags: [ v* ]
14-
edit_url: 'https://github.com/cppalliance/mrdox/edit/{refname}/{path}'
14+
edit_url: 'https://github.com/cppalliance/mrdocs/edit/{refname}/{path}'
1515
sources:
16-
- url: https://github.com/cppalliance/mrdox.git
16+
- url: https://github.com/cppalliance/mrdocs.git
1717
start_path: docs
18-
edit_url: 'https://github.com/cppalliance/mrdox/edit/{refname}/{path}'
18+
edit_url: 'https://github.com/cppalliance/mrdocs/edit/{refname}/{path}'
1919

2020
ui:
2121
bundle:

docs/build_docs.sh

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#
2+
# Licensed under the Apache License v2.0 with LLVM Exceptions.
3+
# See https://llvm.org/LICENSE.txt for license information.
4+
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
5+
#
6+
# Copyright (c) 2023 Alan de Freitas ([email protected])
7+
#
8+
# Official repository: https://github.com/cppalliance/mrdocs
9+
#
10+
11+
# This script is used to build the documentation using Antora
12+
# with the local playbook local-antora-playbook.yml
13+
14+
if [ $# -eq 0 ]
15+
then
16+
echo "No playbook supplied, using default playbook"
17+
PLAYBOOK="antora-playbook.yml"
18+
else
19+
PLAYBOOK=$1
20+
fi
21+
22+
echo "Building documentation with Antora..."
23+
echo "Installing npm dependencies..."
24+
npm install
25+
26+
echo "Building docs in custom dir..."
27+
npx antora --clean --fetch "$PLAYBOOK"
28+
echo "Done"

docs/build_local_docs.sh

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#
2+
# Licensed under the Apache License v2.0 with LLVM Exceptions.
3+
# See https://llvm.org/LICENSE.txt for license information.
4+
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
5+
#
6+
# Copyright (c) 2023 Alan de Freitas ([email protected])
7+
#
8+
# Official repository: https://github.com/cppalliance/mrdocs
9+
#
10+
11+
echo "Building local documentation with Antora..."
12+
./build_docs.sh local-antora-playbook.yml

docs/local-antora-playbook.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
# npx antora --fetch local-antora-playbook.yml
33
site:
44
title: MrDocs
5-
url: https://cppalliance.github.io/mrdox/
6-
start_page: mrdox::index.adoc
5+
url: https://cppalliance.github.io/mrdocs/
6+
start_page: mrdocs::index.adoc
77
robots: allow
88
keys:
9-
repo_url: 'https://github.com/cppalliance/mrdox'
9+
repo_url: 'https://github.com/cppalliance/mrdocs'
1010

1111
content:
1212
sources:
1313
- url: ..
1414
start_path: docs
15-
edit_url: 'https://github.com/cppalliance/mrdox/edit/{refname}/{path}'
15+
edit_url: 'https://github.com/cppalliance/mrdocs/edit/{refname}/{path}'
1616

1717
ui:
1818
bundle:

0 commit comments

Comments
 (0)