Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: DOCS

on:
pull_request:
branches:
- '*'
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
with:
submodules: recursive # ✅ ensure Catch2 is pulled in

- name: Install gcc14
run: |
sudo apt update
sudo apt install -y gcc-14 g++-14
shell: bash

- name: Install Doxygen
run: |
sudo apt update
sudo apt install -y doxygen

- name: Build and Test Project
run: |
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DMSTD_BUILD_DOCS=ON
make docs # at the moment only building docs to verify no doc-related build issues
env:
CC: gcc-14
CXX: g++-14
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ All notable changes to this project will be documented in this file.

- Add Compile flag `MSTD_IGNORE_BUGGY_CODE` to ignore any kind of warnings for buggy libraries or headers
- Add exhaustive error flags for compilation
- Add checking of doxygen comments via building docs (no docs is building for gh pages - yet)

<!-- insertion marker -->
## [0.0.2](https://github.com/97gamjak/mstd/releases/tag/0.0.2) - 2025-11-20
Expand Down
3 changes: 2 additions & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_IF_INCOMPLETE_DOC = YES
WARN_NO_PARAMDOC = NO
WARN_NO_PARAMDOC = YES
WARN_AS_ERROR = YES
WARN_FORMAT = "$file:$line: $text"

#---------------------------------------------------------------------------
Expand Down
1 change: 0 additions & 1 deletion include/mstd/quantity/quantity.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ namespace mstd
/**
* @brief Construct a Quantity from a base value (SI unit).
*
* @param from_base_tag Tag to indicate base value construction.
* @param base The base value in SI units.
*/
constexpr Quantity(from_base_t, Rep base) // base (SI) ctor
Expand Down