From 082ecc38d37555022f5e4280f97bc95a7b0c8a33 Mon Sep 17 00:00:00 2001 From: Alex Baker Date: Tue, 22 Aug 2023 15:46:26 -0700 Subject: [PATCH] Documentation publishing via GH Pages --- .github/workflows/ci-release-docs.yml | 41 +++++++++++++++++++++++++++ .readthedocs.yaml | 19 ------------- 2 files changed, 41 insertions(+), 19 deletions(-) create mode 100644 .github/workflows/ci-release-docs.yml delete mode 100644 .readthedocs.yaml diff --git a/.github/workflows/ci-release-docs.yml b/.github/workflows/ci-release-docs.yml new file mode 100644 index 0000000..2f9f9f1 --- /dev/null +++ b/.github/workflows/ci-release-docs.yml @@ -0,0 +1,41 @@ +name: Doc Builder +on: + release: + types: [published] +permissions: + pages: write + id-token: write +jobs: + build: + name: Python Doc Builder + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.11" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + pip install -r docs/requirements.txt + - name: Sphinx Api Docs + run: sphinx-apidoc -F -H "App Store Server Library" -A "Apple Inc." -V "0.2.1" -e -a -o _staging . tests setup.py + - name: Spinx build + run: sphinx-build -b html _staging _build + - name: Upload docs + uses: actions/upload-pages-artifact@v2 + with: + path: _build + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + needs: build + runs-on: ubuntu-latest + name: Deploy docs + steps: + - name: Deploy + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index 8e2bad5..0000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,19 +0,0 @@ -version: 2 - -build: - os: "ubuntu-20.04" - tools: - python: "3.11" - jobs: - pre_build: - - sphinx-apidoc -F -H "App Store Server Library" -A "Apple Inc." -V "0.2.1" -e -a -o _staging . tests setup.py - -sphinx: - configuration: _staging/conf.py - -python: - install: - - requirements: docs/requirements.txt - - requirements: requirements.txt - - method: pip - path: . \ No newline at end of file