Skip to content

Revise documentation #299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
6 changes: 0 additions & 6 deletions .github/workflows/bvt-appleclang.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-appleclang:
runs-on: macos-15
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: check compiler versions
run: |
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/bvt-clang.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-clang:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: install clang
run: |
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/bvt-compatibility.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-compatibility:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: install compilers
run: |
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/bvt-gcc.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-gcc:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: install gcc
run: |
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/bvt-msvc.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-msvc:
runs-on: windows-2025
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: add cl.exe to PATH
uses: ilammy/msvc-dev-cmd@v1
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/bvt-nvhpc.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-nvhpc:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: install NVHPC 24.9
run: |
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/bvt-report.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
on:
workflow_call:
inputs:
branch:
type: string
required: false

jobs:
bvt-report:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.branch }}

- name: download all workflow run artifacts
uses: actions/download-artifact@v4
Expand Down
34 changes: 34 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
on:
workflow_call:
inputs:
upload-artifacts:
type: boolean
default: false

jobs:
bvt-mkdocs:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
architecture: "x64"

- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install -r mkdocs/requirements.txt

- name: Build site
run: mkdocs build --strict

- name: Upload site artifact
if: ${{ inputs.upload-artifacts }}
uses: actions/upload-pages-artifact@v3
with:
path: ./site
4 changes: 4 additions & 0 deletions .github/workflows/pipeline-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,7 @@ jobs:
uses: ./.github/workflows/bvt-report.yml
name: Generate report
needs: [run-bvt-gcc, run-bvt-clang, run-bvt-msvc, run-bvt-appleclang, run-bvt-nvhpc]

mkdocs:
uses: ./.github/workflows/mkdocs.yml
name: Build mkdocs
27 changes: 27 additions & 0 deletions .github/workflows/pipeline-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Deploy docs to GitHub Pages

on:
push:
branches:
- lkg

jobs:
build:
uses: ./.github/workflows/mkdocs.yml
with:
upload-artifacts: true

deploy:
needs: build
runs-on: ubuntu-24.04
permissions:
id-token: write
pages: write

environment:
name: github-pages
url: ${{ steps.deploy.outputs.page_url }}

steps:
- id: deploy
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.28)

project(msft_proxy VERSION 3.3.0 LANGUAGES CXX)
project(msft_proxy VERSION 4.0.0 LANGUAGES CXX)
add_library(msft_proxy INTERFACE)

# Do not enable building tests if proxy is consumed as
Expand Down
98 changes: 50 additions & 48 deletions README.md

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions docs/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
nav:
- Home: README.md
- Specifications: spec
- Modules Support: modules_support.md
- FAQ: faq.md
9 changes: 9 additions & 0 deletions docs/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
project(msft_proxy_docs)

FetchContent_Declare(
fmt
URL https://github.com/fmtlib/fmt/archive/refs/tags/11.2.0.tar.gz
URL_HASH SHA256=ac366b7b4c2e9f0dde63a59b3feb5ee59b67974b14ee5dc9ea8ad78aa2c1ee1e
)
FetchContent_MakeAvailable(fmt)

find_package(Python3 REQUIRED COMPONENTS Interpreter)

file(GLOB_RECURSE DOC_FILES "*.md")
Expand All @@ -26,3 +33,5 @@ foreach(SOURCE ${EXAMPLE_SOURCES})
target_compile_options(${EXECUTABLE_NAME} PRIVATE -Wall -Wextra -Wpedantic)
endif()
endforeach()

target_link_libraries(example_spec_skills_fmt_format PRIVATE fmt::fmt)
25 changes: 0 additions & 25 deletions docs/ProOverload.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/README.md
34 changes: 0 additions & 34 deletions docs/basic_facade_builder/support_format.md

This file was deleted.

44 changes: 0 additions & 44 deletions docs/basic_facade_builder/support_rtti.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/basic_facade_builder/support_view.md

This file was deleted.

Loading