Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name: docs-check
# includes, broken xrefs)
#
# No deployment. The real publishing path is boostorg/release-tools,
# which auto-detects doc/build_antora.sh and ships to
# which builds via doc/Jamfile.v2 (boostrelease target) and ships to
# www.boost.org/doc/libs/<version>/libs/graph/.

on:
Expand Down Expand Up @@ -59,4 +59,4 @@ jobs:
# against the committed package-lock.json.
- name: Build the site (release-tools entry point)
working-directory: doc
run: ./build_antora.sh playbook.yml
run: ./build_antora.sh
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ example/routing-table.dat
example/figs/ospf-sptree.dot
CMakeFiles/

# Antora docs build artifacts
doc/build/
doc/node_modules/

# macOS
.DS_Store
**/.DS_Store
2 changes: 2 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/build/
/node_modules/
8 changes: 4 additions & 4 deletions doc/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sources under `doc/modules/ROOT/`.
| `doc/modules/ROOT/examples/` | One `.cpp` per page; the build script captures stdout into a sibling `.txt` |
| `doc/modules/ROOT/nav.adoc` | Left-side navigation tree |
| `doc/templates/` | Starter templates: `algorithm.adoc`, `generator.adoc`, `graph_class.adoc` — copy and fill in |
| `doc/playbook.yml` | Antora playbook (UI bundle, content sources) |
| `doc/graph-playbook.yml` | Antora playbook (UI bundle, content sources) |
| `doc/modules/ROOT/examples/Jamfile` | b2 rules that compile every example and snapshot its stdout into a sibling `.txt` |
| `doc/build_example_outputs.sh`| g++-only fallback that does the same thing as the Jamfile, for contributors without a `boost-root` checkout |

Expand All @@ -37,11 +37,11 @@ b2 libs/graph/doc/modules/ROOT/examples

# 2) Build the static site.
cd libs/graph
npx antora doc/playbook.yml
npx antora doc/graph-playbook.yml

# 3) Open the result.
open doc/build/site/index.html # macOS
xdg-open doc/build/site/index.html # Linux
open doc/html/index.html # macOS
xdg-open doc/html/index.html # Linux
```

CI runs the same commands on every push.
Expand Down
1 change: 1 addition & 0 deletions doc/Jamfile.v2
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Copyright 2026 Arnaud Becheler
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

Expand Down
7 changes: 0 additions & 7 deletions doc/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,5 @@ name: graph
version: ~
title: Boost.Graph
start_page: index.adoc
asciidoc:
attributes:
source-language: cpp@
table-caption: false
# Right-rail floating TOC. Set here (not in the playbook) so it travels
# with the component under any deploy playbook, not just the local build.
page-toc: ''
nav:
- modules/ROOT/nav.adoc
24 changes: 5 additions & 19 deletions doc/build_antora.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,14 @@
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#
# Official repository: https://github.com/boostorg/graph
#
# Picked up by boostorg/release-tools' build_docs/{linuxdocs.sh,macosdocs.sh,
# windowsdocs.ps1} via auto-detection: presence of this file selects the
# Antora build pipeline. Output lands in doc/build/site/.
# Run by boostorg/release-tools via the doc/Jamfile.v2 boostrelease target,
# following the boostorg/unordered scheme. Output lands in doc/html/.

set -xe
set -ex

SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
cd "$SCRIPT_DIR"

if [ $# -eq 0 ]; then
PLAYBOOK="playbook.yml"
else
PLAYBOOK="$1"
fi

echo "Installing npm dependencies..."
npm ci

echo "Building docs with Antora using $PLAYBOOK..."
PATH="$(pwd)/node_modules/.bin:${PATH}"
export PATH
npx antora --clean --fetch "$PLAYBOOK"
echo "Done"
npx antora graph-playbook.yml
cp -f html/index.html html/graph.html
12 changes: 3 additions & 9 deletions doc/playbook.yml → doc/graph-playbook.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,21 @@
output:
dir: ./build/site
dir: html

site:
title: Boost.Graph Documentation
start_page: graph::index.adoc

antora:
extensions:
- require: '@antora/lunr-extension'
index_latest_only: true
- require: '@cppalliance/antora-downloads-extension'

content:
sources:
- url: ..
start_path: doc
branches: HEAD
edit_url: 'https://github.com/boostorg/graph/edit/develop/{path}'

asciidoc:
attributes:
source-highlighter: highlight.js

ui:
bundle:
url: https://github.com/boostorg/graph-ui-bundle/raw/c80db72a7ba804256beb36e3a46d9c7df265d8d7/ui-bundle.zip
snapshot: true
output_dir: graph/_
19 changes: 0 additions & 19 deletions doc/index.html

This file was deleted.

Loading
Loading