boostorg · shikharvashistha · Nov 4, 2021 · Dec 18, 2021
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,21 @@
+name: documentation
+'on':
+  push:
+    paths:
+      - doc/**
+  pull_request:
+    paths:
+      - doc/**
+jobs:
+  asciidoc:
+    runs-on: ubuntu-latest
+    name: asciidoc-documentation
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - uses: reitzig/[email protected]
+        with:
+          version: 2.0.10
+      - run: asciidoctor doc/ublas.adoc
diff --git a/doc/ublas.adoc b/doc/ublas.adoc
@@ -5,74 +5,34 @@ Distributed under the Boost Software License, Version 1.0.
 (http://www.boost.org/LICENSE_1_0.txt)
 ////
 
-# Boost.Ublas: The Boost Ublas Library
+# Boost.uBlas: The Boost uBlas Library
 :toc: left
 :toclevels: 2
 :idprefix:
 :listing-caption: Code Example
 :docinfo: private-footer
+:source-highlighter: rouge
+:source-language: c++
 
 :leveloffset: +1
 
-include::ublas/overview.adoc[] 
-
 include::ublas/index.adoc[]
 
-include::ublas/vector.adoc[]
-
-include::ublas/vector_sparse.adoc[]
-
-include::ublas/vector_proxy.adoc[]
-
-include::ublas/vector_expression.adoc[]
-
-include::ublas/matrix.adoc[]
-
-include::ublas/triangular.adoc[]
-
-include::ublas/symmetric.adoc[]
-
-include::ublas/hermitian.adoc[]
-
-include::ublas/banded.adoc[]
-
-include::ublas/matrix_sparse.adoc[]
-
-include::ublas/matrix_proxy.adoc[]
-
-include::ublas/matrix_expression.adoc[]
-
-include::ublas/tensor.adoc[]
-
-include::ublas/tensor/tensor_expression.adoc[]
-
-include::ublas/unbounded_array.adoc[]
-
-include::ublas/bounded_array.adoc[]
-
-include::ublas/range.adoc[]
-
-include::ublas/tensor/extents.adoc[]
-
-include::ublas/tensor/strides.adoc[]
-
-include::ublas/tensor/tensor_expression.adoc[]
-
-include::ublas/tensor/tensor_index.adoc[]
+include::ublas/overview.adoc[]
 
-include::ublas/storage_sparse.adoc[]
+include::ublas/vector-index.adoc[]
 
-include::ublas/products.adoc[]
+include::ublas/matrix-index.adoc[]
 
-include::ublas/blas.adoc[]
+include::ublas/tensor-index.adoc[]
 
-include::ublas/container_concept.adoc[]
+include::ublas/misc.adoc[]
 
-include::ublas/expression_concept.adoc[]
+include::ublas/tutorial.adoc[]
 
-include::ublas/storage_concept.adoc[]
+include::ublas/release.adoc[]
 
-include::ublas/iterator_concept.adoc[]
+include::ublas/contributors.adoc[]
 
 :leveloffset: -1
 
@@ -81,6 +41,6 @@ include::ublas/iterator_concept.adoc[]
 
 This documentation is
 
-* Copyright 2021 Shikhar Vashistha
+* Copyright 2021 link:https://github.com/shikharvashistha[Shikhar Vashistha]
 
 and is distributed under the http://www.boost.org/LICENSE_1_0.txt[Boost Software License, Version 1.0].
diff --git a/doc/ublas/banded.adoc b/doc/ublas/banded.adoc
@@ -1,8 +1,5 @@
 == Banded Matrix
 
-[[toc]]
-
-=== [#banded_matrix]#Banded Matrix#
 
 ==== Description
 
@@ -383,12 +380,4 @@ to the beginning of the reversed `banded_adaptor`.
 
 |`reverse_iterator2 rend2 ()` |Returns a `reverse_iterator2` pointing to
 the end of the reversed `banded_adaptor`.
-|===
-
-'''''
-
-Copyright (©) 2000-2002 Joerg Walter, Mathias Koch +
-Copyright (©) 2021 Shikhar Vashistha +
-Use, modification and distribution are subject to 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).
+|===
diff --git a/doc/ublas/blas.adoc b/doc/ublas/blas.adoc
@@ -1,6 +1,5 @@
 == Level 3 BLAS
 
-[[toc]]
 
 '''''
 
@@ -218,13 +217,4 @@ _m3^H^_) + (_m3_ * (_t2_ * _m2_)^H^)
 *Todo:*::
   use opb_prod()
 
-|===
-
-'''''
-
-Copyright (©) 2000-2004 Michael Stevens, Mathias Koch, Joerg Walter,
-Gunter Winkler +
-Copyright (©) 2021 Shikhar Vashistha +
-Use, modification and distribution are subject to 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).
+|===
diff --git a/doc/ublas/bounded_array.adoc b/doc/ublas/bounded_array.adoc
@@ -1,8 +1,5 @@
 == Bounded Array Storage
 
-[[toc]]
-
-=== [#bounded_array]#Bounded Array#
 
 ==== Description
 
@@ -69,7 +66,7 @@ of the concept.
 
 [cols=",,",]
 |===
-|Member |Where defined |Description 
+|Member |Where defined |Description
 
 |`value_type`| https://www.boost.org/sgi/stl/Container.html[Container] |
 
@@ -93,7 +90,7 @@ of the concept.
 
 |`const_revere_iterator` |https://www.boost.org/sgi/stl/Container.html[Container] |Defined as `std::reverse_iterator<const_iterator>`
 
-|`bounded_array ()` |link:storage_concept.html[Storage] |Creates an `unbounded_array` that holds *zero* elements. 
+|`bounded_array ()` |link:storage_concept.html[Storage] |Creates an `unbounded_array` that holds *zero* elements.
 
 |`bounded_array (size_type size)` |link:storage_concept.html[Storage] |Creates a uninitialized `bounded_array` that holds `size` elements. All the elements are default constructed.
 
@@ -136,11 +133,3 @@ of the concept.
 |`reverse_iterator rend ()` |https://www.boost.org/sgi/stl/ReversibleContainer.html[Reversible Container] |Returns a `reverse_iterator` pointing to the end of the reversed `bounded_array`.
 
 |===
-'''''
-
-Copyright (©) 2000-2004 Michael Stevens, Mathias Koch, Joerg Walter,
-Gunter Winkler +
-Copyright (©) 2021 Shikhar Vashistha +
-Use, modification and distribution are subject to 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 ).
diff --git a/doc/ublas/container_concept.adoc b/doc/ublas/container_concept.adoc
@@ -1,6 +1,5 @@
 == Container Concepts
 
-[[toc]]
 
 === [#vector]#Vector#
 
@@ -214,11 +213,11 @@ Expression] .
 
 [width="100%",cols=",,,,",options="header",]
 |===
-|Name |Expression |Precondition |Semantics |Postcondition 
+|Name |Expression |Precondition |Semantics |Postcondition
 
 |Sizing constructor |`M m (n1, n2)` |`n1 >= 0` and `n2 >= 0` |Allocates a matrix of `n1` rows and `n2` columns. |`m.size1 () == n1` and `m.size2 () == n2`.
 
-|Insert |`m.insert_element (i, j, t)` |`0 < = i < m.size1 ()`, + `0 < = j < m.size2 ()`. |Inserts an element at `m (i, j)` with value `t`. The storage requirement of the Matrix may be increased. `m (i, j)` is equal to `t`. |`m(i,j)` is equal to `t`. 
+|Insert |`m.insert_element (i, j, t)` |`0 < = i < m.size1 ()`, + `0 < = j < m.size2 ()`. |Inserts an element at `m (i, j)` with value `t`. The storage requirement of the Matrix may be increased. `m (i, j)` is equal to `t`. |`m(i,j)` is equal to `t`.
 
 |Erase |`m.erase_element (i, j)` |`0 <= i < m.size1 ()`and ` 0 <= j < m.size2` |Destroys the element as `m (i, j)` and replaces it with the default `value_type ()`. The storage requirement of the Matrix may be decreased. |`m (i, j)` is equal to `value_type ()`.
 
@@ -384,12 +383,3 @@ The run-time complexity of resize is at most linear in the tensor's size
 being a refinement of the TensorExpression. Being a refinement of the
 TensorExpression is only important for the template-expression engine
 but not the user.
-
-'''''
-
-Copyright (©) 2000-2002 Joerg Walter, Mathias Koch +
-Copyright (©) 2018 Cem Bassoy +
-Copyright (©) 2021 Shikhar Vashistha +
-Use, modification and distribution are subject to 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 ).
diff --git a/doc/ublas/contributors.adoc b/doc/ublas/contributors.adoc
@@ -0,0 +1,30 @@
+////
+Copyright 2021 Shikhar Vashistha
+
+Distributed under the Boost Software License, Version 1.0.
+(http://www.boost.org/LICENSE_1_0.txt)
+////
+
+# CONTRIBUTORS
+:toc: left
+:toclevels: 2
+:idprefix:
+:listing-caption: Code Example
+:docinfo: private-footer
+:source-highlighter: rouge
+:source-language: c++
+
+:leveloffset: +1
+'''''
+Copyright (©) 2000-2002 Joerg Walter, Mathias Koch +
+Copyright (©) 2000-2004 Michael Stevens, Gunter Winkler +
+Copyright (©) 2000-2011 link:https://github.com/yimyom[David Bellot] +
+Copyright (©) 2018 link:https://github.com/bassoy[Cem Bassoy] +
+Copyright (©) 2021 link:https://github.com/shikharvashistha[Shikhar Vashistha] +
+Use, modification and distribution are subject to 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 ).
+
+
+
+:leveloffset: -1
diff --git a/doc/ublas/expression_concept.adoc b/doc/ublas/expression_concept.adoc
@@ -1,6 +1,5 @@
 == Expression Concepts
 
-[[toc]]
 
 === [#scalar_expression]#Scalar Expression#
 
@@ -594,11 +593,3 @@ from `m.rbegin2 ()` to `m.rend2 ()`.
 * `matrix_binary_scalar1`
 * `matrix_binary_scalar2`
 * `matrix_matrix_binary`
-
-'''''
-
-Copyright (©) 2000-2002 Joerg Walter, Mathias Koch +
-Copyright (©) 2021 Shikhar Vashistha +
-Use, modification and distribution are subject to 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 ).
diff --git a/doc/ublas/hermitian.adoc b/doc/ublas/hermitian.adoc
@@ -1,8 +1,5 @@
 == Hermitian Matrix
 
-[[toc]]
-
-=== [#hermitian_matrix]#Hermitian Matrix#
 
 ==== Description
 
@@ -399,11 +396,3 @@ the end of the reversed `hermitian_adaptor`.
 
 [#hermitian_adaptor_1]#[1]# Supported parameters for the type of the
 hermitian adaptor are `lower` and `upper`.
-
-'''''
-
-Copyright (©) 2000-2002 Joerg Walter, Mathias Koch +
-Copyright (©) 2021 Shikhar Vashistha +
-Use, modification and distribution are subject to 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 ).