README.md

stlab Documentation

Pull requests for typos, examples, and other improvements are welcome. To file an issue, please use the libraries repository.

Branch states

[ These are from the old site - FIX ME ]

• master:

• develop:

Building (Mac)

You'll need Homebrew to make sure you have the most recent version of Ruby.

Setup

1. Clone the repo
2. brew install ruby
3. sudo gem install bundle jekyll github-pages liquid

Periodically run gem update and bundle update to make sure you have the latest jekyll tooling.

Building Docs

cd ./docs
bundle exec jekyll serve --watch

Documentation viewable at localhost:4000 Modifying sources should auto-regenerate the documentation

Building Examples

1. ./build.sh will download dependencies, build, and run all the *.cpp files in the libraries directory.

Running Hyde in Docker

The following directory structure is assumed.

[ The longer term plan is to migrate the docs for the libraries into the library repo. We also need a plan for the structure of the build directory, a]

.             # This directory stlab.github.io
../libraries  # The stlab/libraries repo
../builds/hyde      # The cmake build directory configures for building docs

Configure the build as follows:

cmake --preset=hyde-build-docs

• Build the docker image per the instructions in the hyde repo, current using the clang13 branch.

docker run --platform linux/x86_64 --mount type=bind,source="$(pwd)/..",target=/mnt/host \
    --tty --interactive \
    hyde bash

From the docker prompt

cd /mnt/host/libraries/docs
./generate_docs.sh
./about.sh

[ this is from the old docs - need to update the docs and script.

(or, simply -u) to generate the boilerplate for it. Then, fill in any fields marked as __MISSING__. Fields marked as __OPTIONAL__ may be omitted. ]