Skip to content

Commit

Permalink
Change documentation to target Github Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
buddly27 committed May 12, 2024
1 parent cea4c9d commit 09c433c
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 14 deletions.
55 changes: 55 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: docs-deploy

on:
push:
branches: [ main ]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: "3.x"

- name: Create Build Environment
run: |
python -m pip install --upgrade pip
python -m pip install -r ${GITHUB_WORKSPACE}/doc/requirements.txt
mkdir -p ${{runner.workspace}}/build
- name: Build documentation
run: |
sphinx-build -T -E -b html \
"${GITHUB_WORKSPACE}/doc" \
"${{runner.workspace}}/build"
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ${{runner.workspace}}/build

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
needs: build

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
13 changes: 0 additions & 13 deletions .readthedocs.yml

This file was deleted.

1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

[![PyPi version](https://img.shields.io/pypi/v/pytest-cmake.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.python.org/pypi/pytest-cmake)
[![CMake](https://img.shields.io/badge/CMake-3.20...3.29-blue.svg?logo=CMake&logoColor=blue)](https://cmake.org)
[![Documentation](https://readthedocs.org/projects/pytest-cmake/badge/?version=stable)](https://pytest-cmake.readthedocs.io/en/stable/)
[![Test](https://github.com/buddly27/pytest-cmake/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/buddly27/pytest-cmake/actions/workflows/test.yml)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Expand Down

0 comments on commit 09c433c

Please sign in to comment.