From bc293d8fb4f5cab90f7ec0ab213eb124bf46ffae Mon Sep 17 00:00:00 2001 From: Justin Abrahms Date: Tue, 27 Jun 2023 10:20:26 -0700 Subject: [PATCH] Automatically render docs to the gh-pages branch --- .github/workflows/build_docs_site.yml | 23 +++++++++++++++++++++++ docs/out/README.md | 4 ++++ 2 files changed, 27 insertions(+) create mode 100644 .github/workflows/build_docs_site.yml create mode 100644 docs/out/README.md diff --git a/.github/workflows/build_docs_site.yml b/.github/workflows/build_docs_site.yml new file mode 100644 index 000000000..1630ee236 --- /dev/null +++ b/.github/workflows/build_docs_site.yml @@ -0,0 +1,23 @@ +on: + push: + branches: + - main + +name: Build Docs + +jobs: + build-docs: + name: Builds the docs + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v3 + - name: install doxygen + run: apt install -y doxygen + - name: build docs + run: ./docs/build.sh + - name: Deploy to GitHub Pages + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: ./docs/out diff --git a/docs/out/README.md b/docs/out/README.md new file mode 100644 index 000000000..501d75a17 --- /dev/null +++ b/docs/out/README.md @@ -0,0 +1,4 @@ +# Noosphere + +You might want the [C docs](./c/). +Or maybe the [rust docs](https://docs.rs/noosphere).