fixed relative links in docs

added header synopses to the reference (#303 )
* added header synopses to the reference * disabled font color override for in-link code portions * relinked bundle
2026-08-06 13:44:12 +02:00 · 2025-01-25 12:42:15 +01:00 · 2025-01-23 20:33:34 +01:00 · 2025-01-21 11:46:01 -08:00 · 2025-01-21 10:55:08 -08:00 · 2025-01-21 09:26:11 +01:00
197 changed files with 3558 additions and 1650 deletions
@@ -1,7 +1,7 @@
 # Boost.Unordered

-[![Branch](https://img.shields.io/badge/branch-master-brightgreen.svg)](https://github.com/boostorg/unordered/tree/master) [![CI](https://github.com/boostorg/unordered/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/boostorg/unordered/actions/workflows/ci.yml) [![Drone status](https://img.shields.io/drone/build/boostorg/unordered/master?server=https%3A%2F%2Fdrone.cpp.al&logo=drone&logoColor=%23CCCCCC&label=CI)](https://drone.cpp.al/boostorg/unordered) [![Build status](https://img.shields.io/appveyor/build/cppalliance/unordered/master?logo=appveyor&label=CI)](https://ci.appveyor.com/project/cppalliance/unordered/branch/master)  [![codecov](https://codecov.io/gh/boostorg/unordered/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/unordered/branch/master)  [![Deps](https://img.shields.io/badge/deps-master-brightgreen.svg)](https://pdimov.github.io/boostdep-report/master/unordered.html)  [![Documentation](https://img.shields.io/badge/docs-master-brightgreen.svg)](https://www.boost.org/doc/libs/master/libs/unordered/doc/html/unordered.html)  [![Enter the Matrix](https://img.shields.io/badge/matrix-master-brightgreen.svg)](http://www.boost.org/development/tests/master/developer/unordered.html)<br/>
-[![Branch](https://img.shields.io/badge/branch-develop-brightgreen.svg)](https://github.com/boostorg/unordered/tree/develop) [![CI](https://github.com/boostorg/unordered/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/boostorg/unordered/actions/workflows/ci.yml) [![Drone status](https://img.shields.io/drone/build/boostorg/unordered/develop?server=https%3A%2F%2Fdrone.cpp.al&logo=drone&logoColor=%23CCCCCC&label=CI)](https://drone.cpp.al/boostorg/unordered) [![Build status](https://img.shields.io/appveyor/build/cppalliance/unordered/master?logo=appveyor&label=CI)](https://ci.appveyor.com/project/cppalliance/unordered/branch/develop) [![codecov](https://codecov.io/gh/boostorg/unordered/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/unordered/branch/develop) [![Deps](https://img.shields.io/badge/deps-develop-brightgreen.svg)](https://pdimov.github.io/boostdep-report/develop/unordered.html) [![Documentation](https://img.shields.io/badge/docs-develop-brightgreen.svg)](https://www.boost.org/doc/libs/develop/libs/unordered/doc/html/unordered.html) [![Enter the Matrix](https://img.shields.io/badge/matrix-develop-brightgreen.svg)](http://www.boost.org/development/tests/develop/developer/unordered.html)<br/>
+[![Branch](https://img.shields.io/badge/branch-master-brightgreen.svg)](https://github.com/boostorg/unordered/tree/master) [![CI](https://github.com/boostorg/unordered/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/boostorg/unordered/actions/workflows/ci.yml) [![Drone status](https://img.shields.io/drone/build/boostorg/unordered/master?server=https%3A%2F%2Fdrone.cpp.al&logo=drone&logoColor=%23CCCCCC&label=CI)](https://drone.cpp.al/boostorg/unordered) [![Build status](https://img.shields.io/appveyor/build/cppalliance/unordered/master?logo=appveyor&label=CI)](https://ci.appveyor.com/project/cppalliance/unordered/branch/master)  [![codecov](https://codecov.io/gh/boostorg/unordered/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/unordered/branch/master)  [![Deps](https://img.shields.io/badge/deps-master-brightgreen.svg)](https://pdimov.github.io/boostdep-report/master/unordered.html)  [![Documentation](https://img.shields.io/badge/docs-master-brightgreen.svg)](https://www.boost.org/doc/libs/master/libs/unordered/index.html)  [![Enter the Matrix](https://img.shields.io/badge/matrix-master-brightgreen.svg)](http://www.boost.org/development/tests/master/developer/unordered.html)<br/>
+[![Branch](https://img.shields.io/badge/branch-develop-brightgreen.svg)](https://github.com/boostorg/unordered/tree/develop) [![CI](https://github.com/boostorg/unordered/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/boostorg/unordered/actions/workflows/ci.yml) [![Drone status](https://img.shields.io/drone/build/boostorg/unordered/develop?server=https%3A%2F%2Fdrone.cpp.al&logo=drone&logoColor=%23CCCCCC&label=CI)](https://drone.cpp.al/boostorg/unordered) [![Build status](https://img.shields.io/appveyor/build/cppalliance/unordered/master?logo=appveyor&label=CI)](https://ci.appveyor.com/project/cppalliance/unordered/branch/develop) [![codecov](https://codecov.io/gh/boostorg/unordered/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/unordered/branch/develop) [![Deps](https://img.shields.io/badge/deps-develop-brightgreen.svg)](https://pdimov.github.io/boostdep-report/develop/unordered.html) [![Documentation](https://img.shields.io/badge/docs-develop-brightgreen.svg)](https://www.boost.org/doc/libs/develop/libs/unordered/index.html) [![Enter the Matrix](https://img.shields.io/badge/matrix-develop-brightgreen.svg)](http://www.boost.org/development/tests/develop/developer/unordered.html)<br/>
 [![BSL 1.0](https://img.shields.io/badge/license-BSL_1.0-blue.svg)](https://www.boost.org/users/license.html) <img alt="C++11 required" src="https://img.shields.io/badge/standard-C%2b%2b11-blue.svg"> <img alt="Header-only library" src="https://img.shields.io/badge/build-header--only-blue.svg">

 Boost.Unordered offers a catalog of hash containers with different standards compliance levels, performances and intented usage scenarios:
@@ -0,0 +1,2 @@
+/build/
+/node_modules/
@@ -1,21 +1,57 @@
-# Copyright 2005 Daniel James.
-# 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)
+import generate ;
+import path ;
+import property-set ;
+import virtual-target ;

-import asciidoctor ;
+path-constant HERE : . ;

-html unordered.html : unordered.adoc ;
+make html/index.html : build_antora.sh : @run-script ;
+generate files-to-install : html/index.html : <generating-rule>@delayed-glob ;
+install install
+  : files-to-install
+  : <location>html
+    <install-source-root>html/unordered
+  ;
+explicit html/index.html files-to-install ;

-install html_ : unordered.html : <location>html ;
+# this runs the antora script
+actions run-script
+{
+    bash $(>)
+}

-pdf unordered.pdf : unordered.adoc ;
-explicit unordered.pdf ;
+# this globs after its sources are created
+rule delayed-glob ( project name : property-set : sources * )
+{
+  for local src in $(sources)
+  {
+    # the next line causes the source to be generated immediately
+    # and not later (which it normally would)
+    UPDATE_NOW [ $(src).actualize ] ;
+  }

-install pdf_ : unordered.pdf : <location>pdf ;
-explicit pdf_ ;
+  # we need to construct the path to the globbed directory;
+  # this path would be <current-project>/antora
+  local root = [ path.root html [ $(project).location ] ] ;
+  local files ;
+
+  # actual globbing happens here
+  for local file in [ path.glob-tree $(root) : * ]
+  {
+    # we have to skip directories, because our match expression accepts anything
+    if [ CHECK_IF_FILE $(file) ]
+    {
+      # we construct a list of targets to copy
+      files += [ virtual-target.from-file $(file:D=) : $(file:D) : $(project) ] ;
+    }
+  }
+
+  # we prepend empty usage requirements to the result
+  return [ property-set.empty ] $(files) ;
+}

 ###############################################################################
 alias boostdoc ;
 explicit boostdoc ;
-alias boostrelease : html_ ;
+alias boostrelease : install ;
 explicit boostrelease ;
@@ -0,0 +1,6 @@
+name: unordered
+version: ~
+title: Boost.Unordered
+nav:
+  - modules/ROOT/nav.adoc
+start_page: intro.adoc
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -ex
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd "$SCRIPT_DIR"
+
+npm ci
+npx antora unordered-playbook.yml
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -ex
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd "$SCRIPT_DIR"
+
+npm ci
+npx antora unordered-playbook.yml
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
joaquintides	3d2c63f744	fixed relative links in docs	2025-01-25 12:42:15 +01:00
joaquintides	87d92996eb	added header synopses to the reference (#303 ) * added header synopses to the reference * disabled font color override for in-link code portions * relinked bundle	2025-01-23 20:33:34 +01:00
Christian Mazakas	17ab97dd4b	Merge pull request #302 from cmazakas/doc/header-fix update ui bundle	2025-01-21 11:46:01 -08:00
Christian Mazakas	2ea05da453	update ui bundle	2025-01-21 10:55:08 -08:00
joaquintides	a2c355cde4	fixed links to docs	2025-01-21 09:26:11 +01:00
Christian Mazakas	18ef4784ec	Merge pull request #299 from cmazakas/antora-documentation Convert documentation to Antora	2025-01-20 08:18:32 -08:00
Christian Mazakas	6ab7e3ec20	update playbook to use commit-specific ui bundle	2025-01-14 15:49:40 -08:00
Christian Mazakas	3b26dcb79e	remove unnecessary files in docs	2025-01-14 12:06:49 -08:00
Christian Mazakas	2ecd00030a	add antora_docs hook, update index.html	2025-01-14 10:55:50 -08:00
Christian Mazakas	1a034bfadd	update ui output path and add b2 support	2025-01-10 16:07:53 -08:00
Christian Mazakas	db3ddc9012	fix image links in benchmarks section	2025-01-09 12:23:46 -08:00
Christian Mazakas	0e768a2dca	fix broken links	2025-01-07 14:50:21 -08:00
Christian Mazakas	d5faa1b5cf	fix broken cross-references	2025-01-07 11:57:39 -08:00
Christian Mazakas	bebd8ccc50	replace index.adoc with intro.adoc	2025-01-06 14:30:20 -08:00
Christian Mazakas	fa8936a343	add missing script contents	2025-01-06 09:35:39 -08:00
Christian Mazakas	db31da1302	fix xrefs and image paths	2025-01-03 09:46:02 -08:00
Christian Mazakas	6f432c0d98	convert docs to antora	2025-01-03 09:45:44 -08:00