Skip to content
Open
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
7 changes: 7 additions & 0 deletions doc/Jamfile.v2
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ xml standalone_doc
asio.qbk
;

explicit standalone_doc ;

install images
:
overview/proactor.png
Expand All @@ -35,6 +37,8 @@ install images
<location>html/boost_asio
;

explicit images ;

local example-names = cpp11/allocation cpp11/buffers cpp11/chat cpp11/deferred
cpp11/echo cpp11/executors cpp11/fork cpp11/futures cpp11/handler_tracking
cpp11/http/client cpp11/http/server cpp11/http/server2 cpp11/http/server3
Expand All @@ -49,6 +53,7 @@ local example-names = cpp11/allocation cpp11/buffers cpp11/chat cpp11/deferred
for local l in $(example-names)
{
install ex_$(l) : [ glob ../example/$(l)/*.*pp ] : <location>html/boost_asio/example/$(l) ;
explicit ex_$(l) ;
}

boostbook standalone
Expand All @@ -66,6 +71,8 @@ boostbook standalone
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/asio/doc/html
;

explicit standalone ;

########################################################################
# HTML documentation for $(BOOST_ROOT)/doc/html

Expand Down
17 changes: 17 additions & 0 deletions doc/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#
# Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
#
# 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)
#

name: asio
version: ~
title: Boost.Asio
start_page: index.adoc
asciidoc:
attributes:
source-language: asciidoc@
table-caption: false
nav:
- modules/ROOT/nav.adoc
25 changes: 25 additions & 0 deletions doc/build_antora.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
@echo off
setlocal

REM
REM Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
REM
REM Distributed under the Boost Software License, Version 1.0. (See accompanying
REM file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
REM

if "%~1"=="" (
echo No playbook supplied, using default playbook
set "PLAYBOOK=local-playbook.yml"
) else (
set "PLAYBOOK=%~1"
)

echo Building documentation with Antora...
echo Installing npm dependencies...
call npm ci

echo Building docs in custom dir...
set "PATH=%CD%\node_modules\.bin;%PATH%"
call npx antora --clean --fetch "%PLAYBOOK%"
echo Done
26 changes: 26 additions & 0 deletions doc/build_antora.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#
# Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
#
# 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)
#

set -xe

if [ $# -eq 0 ]
then
echo "No playbook supplied, using default playbook"
PLAYBOOK="local-playbook.yml"
else
PLAYBOOK=$1
fi

echo "Building documentation with Antora..."
echo "Installing npm dependencies..."
npm ci

echo "Building docs in custom dir..."
PATH="$(pwd)/node_modules/.bin:${PATH}"
export PATH
npx antora --clean --fetch "$PLAYBOOK"
echo "Done"
36 changes: 36 additions & 0 deletions doc/local-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
#
# Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
#
# 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)
#

site:
title: Boost.Asio
url: https://antora.cppalliance.org/develop/lib/doc
start_page: asio::index.adoc
robots: allow
keys:
repo_url: 'https://github.com/boostorg/asio'

content:
sources:
- url: ..
start_path: doc
edit_url: 'https://github.com/boostorg/asio/edit/{refname}/{path}'

ui:
bundle:
url: https://github.com/boostorg/website-v2-docs/releases/download/ui-develop/ui-bundle.zip
snapshot: true

antora:
extensions:
- require: '@asciidoctor/tabs'

asciidoc:
attributes:
# Enable pagination
page-pagination: ''
extensions:
- '@asciidoctor/tabs'
28 changes: 28 additions & 0 deletions doc/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
* xref:index.adoc[Introduction]
* xref:quick-start.adoc[Quick Start]
* Timers
** xref:timers/async-timer.adoc[Async Timer]
** xref:timers/recurring-timer.adoc[Recurring Timer]
* Networking
** xref:networking/tcp-client.adoc[TCP Client]
** xref:networking/tcp-server.adoc[TCP Server]
** xref:networking/udp.adoc[UDP]
** xref:networking/resolving.adoc[DNS Resolution]
* Core Concepts
** xref:core/io-context.adoc[The I/O Context]
** xref:core/buffers.adoc[Buffers]
** xref:core/error-handling.adoc[Error Handling]
** xref:core/streams.adoc[Reading and Writing]
* Threading
** xref:threading/threads.adoc[Multi-Threading]
** xref:threading/strands.adoc[Strands]
* Advanced
** xref:advanced/ssl.adoc[SSL/TLS]
** xref:advanced/signals.adoc[Signal Handling]
** xref:advanced/composed-ops.adoc[Composed Operations]
** xref:advanced/executors.adoc[Executors]
* The Async Model
** xref:async-model/initiating-functions.adoc[Initiating Functions]
** xref:async-model/completion-handlers.adoc[Completion Handlers]
** xref:async-model/memory-model.adoc[Memory and Lifetimes]
* xref:concepts/index.adoc[Concepts Reference]
Loading