From 75084c7b28cfb86d233632435b2c03c39c39c5a0 Mon Sep 17 00:00:00 2001 From: Carlos Date: Thu, 23 Nov 2023 12:57:12 -0700 Subject: [PATCH] - automating sphinx docs --- .github/workflows/sphinx_build.yml | 12 ++++++++++++ sphinx_docs_build/requirements.txt | 1 + 2 files changed, 13 insertions(+) create mode 100644 .github/workflows/sphinx_build.yml create mode 100644 sphinx_docs_build/requirements.txt diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml new file mode 100644 index 0000000..0684b9f --- /dev/null +++ b/.github/workflows/sphinx_build.yml @@ -0,0 +1,12 @@ +name: "Pull Request Sphinx Docs Check" +on: +- pull_request + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master + with: + docs-folder: "sphinx_docs_build/" \ No newline at end of file diff --git a/sphinx_docs_build/requirements.txt b/sphinx_docs_build/requirements.txt new file mode 100644 index 0000000..68273bc --- /dev/null +++ b/sphinx_docs_build/requirements.txt @@ -0,0 +1 @@ +sphinx-rtd-theme==1.3.0 \ No newline at end of file