diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml deleted file mode 100644 index 77785caa6..000000000 --- a/.github/workflows/docs_deploy.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Deploy documentation - -on: - push: - branches: - - main - paths: - - 'docs/*' - - 'include/fastgltf/*.hpp' - pull_request: - paths: - - 'docs/*' - - 'include/fastgltf/*.hpp' - workflow_dispatch: - -jobs: - deploy: - runs-on: ubuntu-latest - permissions: - pages: write - id-token: write - concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - steps: - - uses: actions/checkout@v3 - - - name: Install CMake dependencies - run: sudo apt-get install doxygen - - - name: Install Python dependencies - run: pip3 install -U Sphinx breathe sphinx_rtd_theme - - - name: Add ~/.local/bin to PATH - run: PATH=$HOME/.local/bin:$PATH - - - name: Configure CMake project - run: cmake -B ${{ github.workspace }}/build -DFASTGLTF_ENABLE_DOCS=ON - - - name: Build docs CMake target - run: cmake --build ${{ github.workspace }}/build --target generate_sphinx --verbose - - - name: Upload pages artifact - uses: actions/upload-pages-artifact@v2 - if: github.ref == 'refs/heads/main' - with: - path: ${{ github.workspace }}/build/docs/sphinx - - - name: Deploy site - uses: actions/deploy-pages@v2 - if: github.ref == 'refs/heads/main' diff --git a/README.md b/README.md index cbb3cfbb4..4344ca099 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ ![conan center](https://img.shields.io/conan/v/fastgltf?style=flat-square) ![CI_x64 workflow status](https://img.shields.io/github/actions/workflow/status/spnda/fastgltf/ci_x64.yml?label=CI%20x64&style=flat-square) ![CI_arm workflow status](https://img.shields.io/github/actions/workflow/status/spnda/fastgltf/ci_arm.yml?label=CI%20ARM&style=flat-square) +[![Documentation Status](https://readthedocs.org/projects/fastgltf/badge/?version=latest)](https://fastgltf.readthedocs.io/latest/?badge=latest) **fastgltf** is a speed and usability focused glTF 2.0 parser written in modern C++17 with minimal dependencies. @@ -15,7 +16,7 @@ By default, fastgltf will only do the absolute minimum to work with a glTF model However, it brings many additional features to ease working with the data, including accessor tools, the ability to directly write to mapped GPU buffers, and decomposing transform matrices. -To learn more about fastgltf, its features, performance and API you can read [the docs](https://spnda.github.io/fastgltf). +To learn more about fastgltf, its features, performance and API you can read [the docs](https://fastgltf.readthedocs.io/v0.6.x/). ## License