Documentation

For Users

There are three uBLAS documentation locations.

1. One is the doc folder of this repo. Starting point is the ublas.adoc ascii-doc file.
2. One is the Github page. It is generated from the files inside the doc folder. It documents code of the develop branch.
3. One is the official Boost documentation. The documentations refers to code inside the master branch.

For Developers

There are two Github actions that continuously compile AsciiDoc documentation in the doc folder into a single well readable html file. Soon both will be merged into one Github action.

1. This Github action checks the compilation of the existing AsciiDoc Boost.uBlas documentation. It is triggered for every branch.

2. This Github action checks the compilation of the Boost.uBlas documentation in the feature/doc branch and generates html files which are pushed into the (https://github.com/boostorg/ublas/blob/gh-pages) branch in order to create/update https://boostorg.github.io/ublas/.