Merge pull request #52 from gprt-org/docs

Documentation for samples 0 and 1

.github/workflows/docs.yml

@@ -30,11 +30,10 @@ jobs:
       - run: pip install -r ./docs/requirements.txt
 
       - name: Prepare Vulkan SDK
-        uses: humbletim/setup-vulkan-sdk@v1.2.0
+        uses: humbletim/install-vulkan-sdk@v1.1.1
         with:
-          vulkan-query-version: 1.3.204.0
-          vulkan-components: Vulkan-Headers, Vulkan-Loader
-          vulkan-use-cache: true
+          version: 1.3.231.1
+          cache: true
 
       - name: Apt dependencies
         shell: bash
@@ -46,21 +45,13 @@ jobs:
                               freeglut3-dev \
                               mesa-common-dev \
                               doxygen
-      - name: Setup environment
-        shell: bash
-        run: |
-          echo "PATH=$HOME/dxc-artifacts/bin:$PATH" >> $GITHUB_ENV
-      - name: Pull and unpack dxc compiler
-        shell: bash
-        run: |
-          ./util/download-dxc.sh
       - name: Build Documentation
         shell: bash
         run: |
           mkdir bld
           cd bld
           cmake --version
-          cmake .. -DVulkan_BIN_DIR=$HOME/dxc-artifacts/bin -DBUILD_DOC=ON
+          cmake .. -DBUILD_DOC=ON
           cmake --build . --target sphinx --config Release
       - name: Setup Pages
         uses: actions/configure-pages@v2

README.md

@@ -3,9 +3,10 @@
 [![CI](https://github.com/natevm/vkrt/actions/workflows/ci.yml/badge.svg)](https://github.com/natevm/vkrt/actions/workflows/ci.yml)
 
 # GPRT (General Purpose Raytracing Toolkit)
-
 GPRT is a ray tracing API that wraps the Vulkan ray tracing interface.
 
+![Sample "Attribute Aware RBFs" images](docs/source/images/papers/vis2023.jpg)
+
 ## Dependencies
 
   - CMake

docs/source/_static/css/epub_overrides.css

@@ -0,0 +1,23 @@
+/*
+ * This stylesheet is applied after the theme's default one,
+ * and thus any overrides or additions can be added here.
+ *
+ * More info:
+ *		https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_css_file
+ */
+
+/* Allow text to flow around right aligned images */
+.align-right {
+  float: right;
+  margin: 0 0 24px 24px;
+}
+
+/* Prevent images from flowing into other headings */
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  clear: both;
+}