Skip to content

Update doc build instructions #342

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.

Sign up for GitHub

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

Merged
merged 13 commits into from
Nov 28, 2024
Merged

Update doc build instructions #342

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3412f9c
Update build instructions in DevelopersDocumentation.rst
mcbarton Oct 28, 2024
38ab613
Update build instructions in InstallationAndUsage.rst
mcbarton Oct 28, 2024
a821d33
Format to 80 columns
mcbarton Oct 28, 2024
17610f6
Add job to ci to build docs
mcbarton Nov 27, 2024
c821733
Debug
mcbarton Nov 27, 2024
8507fe0
Change docs to documentation
mcbarton Nov 27, 2024
1bf5e74
Debug
mcbarton Nov 27, 2024
9ec918a
Merge branch 'main' into Update-doc-build-instructions
mcbarton Nov 27, 2024
cfb573a
Install doxygen ci
mcbarton Nov 27, 2024
fa934bd
Install dot and sphinx
mcbarton Nov 27, 2024
82b6acf
build doxygen-cppinterop ci docs job
mcbarton Nov 27, 2024
73f0c6e
Fix docs job
mcbarton Nov 27, 2024
b1aab78
Don't do Valgrind test when building docs
mcbarton Nov 27, 2024
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
44 changes: 35 additions & 9 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,39 +481,51 @@ jobs:
fail-fast: false
matrix:
include:
- name: ubu22-x86-gcc12-clang-repl-19-docs
os: ubuntu-22.04
compiler: gcc-12
clang-runtime: '19'
cling: Off
cppyy: Off
docs: On
- name: ubu22-x86-gcc12-clang-repl-19-cppyy
os: ubuntu-22.04
compiler: gcc-12
clang-runtime: '19'
cling: Off
cppyy: On
coverage: true
docs: Off
- name: ubu22-x86-gcc12-clang-repl-18-cppyy
os: ubuntu-22.04
compiler: gcc-12
clang-runtime: '18'
cling: Off
cppyy: On
coverage: true
docs: Off
- name: ubu22-x86-gcc12-clang-repl-17-cppyy
os: ubuntu-22.04
compiler: gcc-12
clang-runtime: '17'
cling: Off
cppyy: On
docs: Off
- name: ubu22-x86-gcc12-clang-repl-16-cppyy
os: ubuntu-22.04
compiler: gcc-12
clang-runtime: '16'
cling: Off
cppyy: On
docs: Off
- name: ubu22-x86-gcc9-clang13-cling-cppyy
os: ubuntu-22.04
compiler: gcc-9
clang-runtime: '13'
cling: On
cling-version: '1.0'
cppyy: On
docs: Off
#FIXME: Windows CppInterOp tests expected to fail
#until https://github.com/compiler-research/CppInterOp/issues/188 is solved
- name: win2022-msvc-clang-repl-19
Expand All @@ -522,18 +534,21 @@ jobs:
clang-runtime: '19'
cling: Off
cppyy: Off
docs: Off
- name: win2022-msvc-clang-repl-18
os: windows-2022
compiler: msvc
clang-runtime: '18'
cling: Off
cppyy: Off
docs: Off
- name: win2022-msvc-clang-repl-17
os: windows-2022
compiler: msvc
clang-runtime: '17'
cling: Off
cppyy: Off
docs: Off
#- name: win2022-msvc-clang-repl-17-cppyy
# os: windows-2022
# compiler: msvc
Expand All @@ -546,62 +561,72 @@ jobs:
clang-runtime: '19'
cling: Off
cppyy: On
docs: Off
- name: osx14-arm-clang-clang-repl-18-cppyy
os: macos-14
compiler: clang
clang-runtime: '18'
cling: Off
cppyy: On
docs: Off
- name: osx14-arm-clang-clang-repl-17-cppyy
os: macos-14
compiler: clang
clang-runtime: '17'
cling: Off
cppyy: On
docs: Off
- name: osx14-arm-clang-clang-repl-16-cppyy
os: macos-14
compiler: clang
clang-runtime: '16'
cling: Off
cppyy: On
docs: Off
- name: osx14-arm-clang-clang13-cling-cppyy
os: macos-14
compiler: clang
clang-runtime: '13'
cling: On
cling-version: '1.0'
cppyy: On
docs: Off
- name: osx13-x86-clang-clang-repl-19-cppyy
os: macos-13
compiler: clang
clang-runtime: '19'
cling: Off
cppyy: On
docs: Off
- name: osx13-x86-clang-clang-repl-18-cppyy
os: macos-13
compiler: clang
clang-runtime: '18'
cling: Off
cppyy: On
docs: Off
- name: osx13-x86-clang-clang-repl-17-cppyy
os: macos-13
compiler: clang
clang-runtime: '17'
cling: Off
cppyy: On
docs: Off
- name: osx13-x86-clang-clang-repl-16-cppyy
os: macos-13
compiler: clang
clang-runtime: '16'
cling: Off
cppyy: On
docs: Off
- name: osx13-x86-clang-clang13-cling-cppyy
os: macos-13
compiler: clang
clang-runtime: '13'
cling: On
cling-version: '1.0'
cppyy: On
docs: Off

steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -834,15 +859,16 @@ jobs:
-DLLVM_ENABLE_WERROR=On \
../
else
cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
-DUSE_CLING=OFF \
-DUSE_REPL=ON \
-DLLVM_DIR=$LLVM_BUILD_DIR/lib/cmake/llvm \
-DClang_DIR=$LLVM_BUILD_DIR/lib/cmake/clang \
-DBUILD_SHARED_LIBS=ON \
-DCODE_COVERAGE=${{ env.CODE_COVERAGE }} \
-DCMAKE_INSTALL_PREFIX=$CPPINTEROP_DIR \
-DLLVM_ENABLE_WERROR=On \
cmake -DCMAKE_BUILD_TYPE=${{ env.BUILD_TYPE }} \
-DUSE_CLING=OFF \
-DUSE_REPL=ON \
-DLLVM_DIR=$LLVM_BUILD_DIR/lib/cmake/llvm \
-DCPPINTEROP_INCLUDE_DOCS=${{ matrix.docs }} \
-DClang_DIR=$LLVM_BUILD_DIR/lib/cmake/clang \
-DBUILD_SHARED_LIBS=ON \
-DCODE_COVERAGE=${{ env.CODE_COVERAGE }} \
-DCMAKE_INSTALL_PREFIX=$CPPINTEROP_DIR \
-DLLVM_ENABLE_WERROR=On \
../
fi
os="${{ matrix.os }}"
Expand Down
Loading