diff --git a/.github/workflows/buildAndRunTests.yml b/.github/workflows/buildAndRunTests.yml index 2dcca229..1ee5d02c 100644 --- a/.github/workflows/buildAndRunTests.yml +++ b/.github/workflows/buildAndRunTests.yml @@ -5,6 +5,7 @@ on: - docs/** - '**.md' - '**.markdown' + - '**.yml' branches: [ master ] pull_request: paths-ignore: diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 5b5862c9..1bee4e4f 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -17,6 +17,7 @@ on: - docs/** - '**.md' - '**.markdown' + - '**.yml' branches: [ master ] pull_request: paths-ignore: diff --git a/.github/workflows/ctest.yml b/.github/workflows/ctest.yml index 65111c9f..ffd374d1 100644 --- a/.github/workflows/ctest.yml +++ b/.github/workflows/ctest.yml @@ -12,6 +12,7 @@ on: - docs/** - "**.md" - "**.markdown" + - '**.yml' branches: - master env: diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c40efcc4..917d0070 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,11 +1,13 @@ -name: Publish docs via GitHub Pages to https://kjellkod.github.io/g3log/ +name: doc_publish +# Publish docs via GitHub Pages to https://kjellkod.github.io/g3log/ on: push: branches: - master paths: - "**.md" - - "mkdocs.yml" + - "**.yml" + - docs/** jobs: @@ -16,7 +18,7 @@ jobs: - uses: actions/setup-python@v5 with: python-version: 3.x - - run: pip install mkdocs-material + - run: pip install mkdocs && pip install mkdocs-material - name: Build site run: mkdocs build - name: Deploy diff --git a/README.md b/README.md index 61f3403d..06ecd90b 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ G3log is an asynchronous logger with three main features: The super quick introduction to g3log can be seen in the steps 1 - 9 below. -For more in-depth information please see the full usage description in [g3log_usage.md](docs/g3log_usage.md).If you want to understand better the internals of g3log, then plase look at the [API.md](docs/API.md) for both high-level and deep-dive insights. +For more in-depth information please see the full usage description in [g3log_usage.md](docs/g3log_usage.md). If you want to understand better the internals of g3log, then plase look at the [API.md](docs/API.md) for both high-level and deep-dive insights. ## Experiment and try-out g3log in Github Codespaces @@ -28,7 +28,7 @@ Avoid deep dependency injection complexity and instead get access to the logger ## 2. Access to streaming and print_f log call syntax -Both streaming syntax `LOG` and print_f `LOGF` syntax are available. +Both streaming syntax `LOG` and print_f `LOGF` syntax are available ``` LOGF(INFO, "Hi log %d", 123); diff --git a/docs/API.md b/docs/API.md index 05343235..a0fceeb7 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,7 +1,7 @@ [introduction](index.md) | [detailed information](g3log_usage.md) | [Configure & Build](building.md) | [**API description**](API.md) | [Custom log formatting](API_custom_formatting.md) # High Level Description of g3log -The `g3log` logger is an asynchronous, crash-safe logging library designed for C++ applications. It allows for logging messages to various sinks without blocking the main application thread. Below is a high-level overview of how the `g3log` logger works: +The `g3log` logger is an asynchronous, crash-safe logging library designed for C++ applications. It allows for logging messages to various sinks without blocking the main application thread. Below is a high-level overview of how the `g3log` logger works. ## Asynchronous Logging The logger operates on a separate thread, ensuring that the main application thread is not blocked by I/O operations when logging messages. This is achieved by using a background worker ([`LogWorker`](../src/g3log/logworker.hpp)) that queues log messages and processes them asynchronously. diff --git a/mkdocs.yml b/mkdocs.yml index 7a8dc2bf..5009f624 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,10 +1,11 @@ site_name: G3log, an asynchronous "crash-safe" logger site_author: 'Kjell Hedström' +theme: + name: material plugins: - search docs_dir: docs/ -theme: - name: material + nav: - Introduction to G3log: index.md - G3log usage: g3log.md