forked from boostorg/accumulators
-
Notifications
You must be signed in to change notification settings - Fork 1
Convert Accumulators documentation from QuickBook to AsciiDoc/Antora #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
myzhang-1127
wants to merge
11
commits into
CppDigest:develop
Choose a base branch
from
myzhang-1127:develop
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
03845a8
Add Antora documentation (AsciiDoc) under doc/
myzhang-1127 3d9d262
complete 0.2
myzhang-1127 318172a
completed1.0
myzhang-1127 96bf0ff
completed1.1
myzhang-1127 08d82d8
cmopleted 1.3
myzhang-1127 c09b49b
completed 1.4
myzhang-1127 72199ac
completed 2.0
myzhang-1127 5e6a12b
Remove Archive.zip and add comprehensive documentation for Boost.Accu…
myzhang-1127 ee30538
clean up repository
myzhang-1127 0ad21b0
clean up repository
myzhang-1127 d411b15
handle comment
myzhang-1127 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # | ||
| # Generated for Boost.Accumulators documentation (Antora). | ||
| # Distributed under the Boost Software License, Version 1.0. | ||
| # | ||
|
|
||
| name: accumulators | ||
| version: ~ | ||
| title: Boost.Accumulators | ||
| start_page: index.adoc | ||
| asciidoc: | ||
| attributes: | ||
| source-language: asciidoc@ | ||
| table-caption: false | ||
| nav: | ||
| - modules/ROOT/nav.adoc |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Copyright 2005, 2006 Eric Niebler | ||
| # Copyright 2026 boost-doc-modernize contributors | ||
| # | ||
| # Distributed under the Boost Software License, Version 1.0. | ||
| # | ||
| # Build Antora site under doc/build/site. | ||
| # Installs Node dependencies and runs Antora using the selected playbook. | ||
| # | ||
|
|
||
| set -xe | ||
|
|
||
| SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) | ||
| cd "$SCRIPT_DIR" | ||
|
|
||
| if [ -z "${BOOST_SRC_DIR:-}" ]; then | ||
| CANDIDATE=$( cd "$SCRIPT_DIR/../../.." 2>/dev/null && pwd ) | ||
| if [ -n "$CANDIDATE" ]; then | ||
| BOOST_SRC_DIR_IS_VALID=ON | ||
| for F in "CMakeLists.txt" "Jamroot" "boost-build.jam" "bootstrap.sh" "libs"; do | ||
| if [ ! -e "$CANDIDATE/$F" ]; then | ||
| BOOST_SRC_DIR_IS_VALID=OFF | ||
| break | ||
| fi | ||
| done | ||
| if [ "$BOOST_SRC_DIR_IS_VALID" = "ON" ]; then | ||
| export BOOST_SRC_DIR="$CANDIDATE" | ||
| echo "Using BOOST_SRC_DIR=$BOOST_SRC_DIR" | ||
| fi | ||
| fi | ||
| fi | ||
|
|
||
| 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 install | ||
|
|
||
| echo "Building docs in custom dir..." | ||
| PATH="$(pwd)/node_modules/.bin:${PATH}" | ||
| export PATH | ||
| npx antora --clean --fetch "$PLAYBOOK" --stacktrace --log-level all | ||
| echo "Done" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # | ||
|
myzhang-1127 marked this conversation as resolved.
|
||
| # Local Antora playbook for Boost.Accumulators | ||
| # | ||
|
|
||
| site: | ||
| title: Boost.Accumulators | ||
| url: https://antora.cppalliance.org/develop/lib/doc | ||
| start_page: accumulators::index.adoc | ||
| robots: allow | ||
| keys: | ||
| repo_url: 'https://github.com/boostorg/accumulators' | ||
|
|
||
| content: | ||
| sources: | ||
| - url: .. | ||
| start_path: doc | ||
| edit_url: 'https://github.com/boostorg/accumulators/edit/{refname}/{path}' | ||
|
|
||
| ui: | ||
| bundle: | ||
| url: https://github.com/boostorg/website-v2-docs/releases/download/ui-master/ui-bundle.zip | ||
| snapshot: true | ||
|
|
||
|
|
||
| antora: | ||
| extensions: | ||
| - require: '@antora/lunr-extension' # https://gitlab.com/antora/antora-lunr-extension | ||
| index_latest_only: true | ||
| - require: '@cppalliance/antora-cpp-tagfiles-extension' | ||
| cpp-tagfiles: | ||
| using-namespaces: | ||
| - 'boost::' | ||
| - require: '@cppalliance/antora-cpp-reference-extension' | ||
| dependencies: | ||
| - name: 'boost' | ||
| repo: 'https://github.com/boostorg/boost.git' | ||
| tag: 'develop' | ||
| variable: 'BOOST_SRC_DIR' | ||
| system-env: 'BOOST_SRC_DIR' | ||
| - require: '@cppalliance/antora-downloads-extension' | ||
|
|
||
| asciidoc: | ||
| attributes: | ||
| # Enable pagination | ||
| page-pagination: '' | ||
| extensions: | ||
| - '@cppalliance/asciidoctor-boost-links' | ||
| - '@asciidoctor/tabs' | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| * xref:index.adoc[] | ||
| * xref:preface.adoc[Preface] | ||
| * xref:user_s_guide.adoc[User's Guide] | ||
| * xref:acknowledgements.adoc[Acknowledgements] | ||
| * xref:reference.adoc[Reference] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| = Acknowledgements | ||
| :id: accumulators.acknowledgements | ||
|
|
||
| Boost.Accumulators represents the efforts of many individuals. I would like to thank Daniel Egloff of link:https://www.zkb.com[Zürcher Kantonalbank] for helping to conceive the library and realize its implementation. I would also like to thank David Abrahams and Matthias Troyer for their key contributions to the design of the library. Many thanks are due to Michael Gauckler and Olivier Gygi, who, along with Daniel Egloff, implemented many of the statistical accumulators. | ||
|
|
||
| I would also like to thank Simon West for all his assistance maintaining Boost.Accumulators. | ||
|
|
||
| Finally, I would like to thank link:https://www.zkb.com[Zürcher Kantonalbank] for sponsoring the work on Boost.Accumulators and graciously donating it to the community. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| = Chapter 1. Boost.Accumulators | ||
|
|
||
| *Eric Niebler* | ||
|
|
||
| Incremental accumulation framework and statistical accumulator library. | ||
|
|
||
| Copyright (C) 2005, 2006 Eric Niebler + | ||
| Distributed under the Boost Software License, Version 1.0. + | ||
| (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt) | ||
|
|
||
| [.accumulators-mini-toc] | ||
| **** | ||
| **Table of Contents** | ||
|
|
||
| * xref:preface.adoc[Preface] | ||
| * xref:user_s_guide.adoc[User's Guide] | ||
| ** xref:user_s_guide.adoc#accumulators.user_s_guide.the_accumulators_framework[The Accumulators Framework] | ||
| ** xref:user_s_guide.adoc#accumulators.user_s_guide.the_statistical_accumulators_library[The Statistical Accumulators Library] | ||
| * xref:acknowledgements.adoc[Acknowledgements] | ||
| * xref:reference.adoc[Reference] | ||
| ** xref:reference.adoc#accumulators_framework_reference[Accumulators Framework Reference] | ||
| ** xref:reference.adoc#statistics_library_reference[Statistics Library Reference] | ||
| ** xref:reference.adoc#numeric_operators_library_reference[Numeric Operators Library Reference] | ||
| **** | ||
|
|
||
| == Preface | ||
|
|
||
| [quote] | ||
| ____ | ||
| It is better to be approximately right than exactly wrong. | ||
|
|
||
| -- Old adage | ||
| ____ | ||
|
|
||
| == Description | ||
|
|
||
| Boost.Accumulators is both a library for incremental statistical computation as well as an extensible framework for incremental calculation in general. The library deals primarily with the concept of an _accumulator_, which is a primitive computational entity that accepts data one sample at a time and maintains some internal state. These accumulators may offload some of their computations on other accumulators, on which they depend. Accumulators are grouped within an _accumulator set_. Boost.Accumulators resolves the inter-dependencies between accumulators in a set and ensures that accumulators are processed in the proper order. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| = Preface | ||
| :id: accumulators.preface | ||
|
|
||
| [quote] | ||
| ____ | ||
| It is better to be approximately right than exactly wrong. -- Old adage | ||
| ____ | ||
|
|
||
|
|
||
| [[accumulators.preface.h0]] | ||
|
|
||
| [[accumulators.preface.description]] | ||
|
|
||
| == Description | ||
|
|
||
| Boost.Accumulators is both a library for incremental statistical computation as well as an extensible framework for incremental calculation in general. The library deals primarily with the concept of an _accumulator_, which is a primitive computational entity that accepts data one sample at a time and maintains some internal state. These accumulators may offload some of their computations on other accumulators, on which they depend. Accumulators are grouped within an _accumulator set_. Boost.Accumulators resolves the inter-dependencies between accumulators in a set and ensures that accumulators are processed in the proper order. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.