Skip to content
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

Jump to bottom

Fix doc links #385

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Fix doc links #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0034ccf
expose `vulkan_compile_shader` with CMake install
kwsp Jul 28, 2024
f840aaf
wip
kwsp Jul 29, 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
7 changes: 7 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,13 @@ if(KOMPUTE_OPT_INSTALL)
FILE komputeTargets.cmake
NAMESPACE kompute::
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/kompute)

# Copy CMake files needed to `vulkan_compile_shader`
install(FILES
cmake/vulkan_shader_compiler.cmake
cmake/bin_file_to_header.cmake
cmake/bin2h.cmake
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/kompute)
endif()


Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Simplified Kompute Components

<br>
<br>
(very tiny, check the <a href="https://ethicalml.github.io/vulkan-kompute/overview/reference.html">full reference diagram in docs for details</a>)
(very tiny, check the <a href="https://kompute.cc/overview/reference.html">full reference diagram in docs for details</a>)
<br>
<br>

Expand All @@ -374,7 +374,7 @@ The image below provides an intuition on how Kompute Sequences can be allocated

## Mobile Enabled

Kompute has been optimized to work in mobile environments. The [build system](#build-overview) enables for dynamic loading of the Vulkan shared library for Android environments, together with a working [Android NDK wrapper](https://github.com/KomputeProject/kompute/tree/master/vk_ndk_wrapper_include) for the CPP headers.
Kompute has been optimized to work in mobile environments. The [build system](#build-overview) enables for dynamic loading of the Vulkan shared library for Android environments.

<table>
<tr>
Expand Down
5 changes: 4 additions & 1 deletion cmake/komputeConfig.cmake.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,7 @@ find_dependency(Vulkan REQUIRED)

include(${CMAKE_CURRENT_LIST_DIR}/komputeTargets.cmake)

check_required_components(kompute)
# Expose `vulkan_compile_shader`
include(${CMAKE_CURRENT_LIST_DIR}/vulkan_shader_compiler.cmake)

check_required_components(kompute)
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Kompute Docs Home
==========================================

High Level Overview (from README)
--------
---------------------------------

.. mdinclude:: ../README.md

Expand Down
4 changes: 3 additions & 1 deletion docs/overview/async-parallel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,7 @@ The reason why this is important is that the Await function not only waits for t
Async and Parallel Examples
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

We have added a set of examples for asynchronous and parallel processing examples in the `Advanced Examples documentation page <advanced-examples.rst>`_
.. _advanced-examples::advanced-examples.rst

We have added a set of examples for asynchronous and parallel processing examples in the `Advanced Examples documentation page :ref:_advanced-examples`