From 306e808da19e56832e7cd811384a00ccc7969246 Mon Sep 17 00:00:00 2001 From: Martin Gerhardy Date: Sun, 21 Feb 2021 14:02:30 +0100 Subject: [PATCH] CI: added github pages build job --- .github/workflows/gh-pages.yml | 18 ++++++++++++++ mkdocs.yml | 43 ++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 .github/workflows/gh-pages.yml create mode 100644 mkdocs.yml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 000000000..f73778061 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,18 @@ +name: GitHub Pages +on: + push: + branches: + - master + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout master + uses: actions/checkout@v1 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@1.14 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..325434c68 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,43 @@ +site_name: SDL +site_description: Simple Direct Media Layer +docs_dir: docs +site_dir: build/docs +repo_url: https://github.com/libsdl-org/SDL +repo_name: GitHub + +theme: + name: readthedocs + highlightjs: true + hljs_languages: [c] + +markdown_extensions: + - toc: + toc_depth: 2 + +nav: + - README.md + - README-android.md + - README-cmake.md + - README-directfb.md + - README-dynapi.md + - README-emscripten.md + - README-gesture.md + - README-git.md + - README-hg.md + - README-ios.md + - README-kmsbsd.md + - README-linux.md + - README-macosx.md + - README.md + - README-nacl.md + - README-os2.md + - README-pandora.md + - README-platforms.md + - README-porting.md + - README-psp.md + - README-raspberrypi.md + - README-touch.md + - README-visualc.md + - README-wince.md + - README-windows.md + - README-winrt.md