mirror of
				https://github.com/NinjaCheetah/libWiiPy.git
				synced 2025-11-04 08:26:18 -05:00 
			
		
		
		
	Added workflow to build and publish docs on push
This commit is contained in:
		
							parent
							
								
									6575dd37f7
								
							
						
					
					
						commit
						da2d6b0003
					
				
							
								
								
									
										60
									
								
								.github/workflows/sphinx-docs.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										60
									
								
								.github/workflows/sphinx-docs.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,60 @@
 | 
				
			|||||||
 | 
					# Workflow to build libWiiPy documentation with Sphinx and then publish it
 | 
				
			||||||
 | 
					name: Build and publish documentation with Sphinx
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					on:
 | 
				
			||||||
 | 
					  # Runs on pushes targeting the default branch
 | 
				
			||||||
 | 
					  push:
 | 
				
			||||||
 | 
					    branches: ["main"]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  # Allows you to run this workflow manually from the Actions tab
 | 
				
			||||||
 | 
					  workflow_dispatch:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 | 
				
			||||||
 | 
					permissions:
 | 
				
			||||||
 | 
					  contents: read
 | 
				
			||||||
 | 
					  pages: write
 | 
				
			||||||
 | 
					  id-token: write
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 | 
				
			||||||
 | 
					# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 | 
				
			||||||
 | 
					concurrency:
 | 
				
			||||||
 | 
					  group: "pages"
 | 
				
			||||||
 | 
					  cancel-in-progress: false
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					jobs:
 | 
				
			||||||
 | 
					  # Build job
 | 
				
			||||||
 | 
					  build:
 | 
				
			||||||
 | 
					    runs-on: ubuntu-latest
 | 
				
			||||||
 | 
					    steps:
 | 
				
			||||||
 | 
					      - name: Checkout
 | 
				
			||||||
 | 
					        uses: actions/checkout@v4
 | 
				
			||||||
 | 
					      - name: Setup Pages
 | 
				
			||||||
 | 
					        uses: actions/configure-pages@v5
 | 
				
			||||||
 | 
					      - name: Set up Python 3.11
 | 
				
			||||||
 | 
					        uses: actions/setup-python@v5
 | 
				
			||||||
 | 
					        with:
 | 
				
			||||||
 | 
					          python-version: "3.11"
 | 
				
			||||||
 | 
					      - name: Install Dependencies
 | 
				
			||||||
 | 
					        run: |
 | 
				
			||||||
 | 
					          python -m pip install --upgrade pip
 | 
				
			||||||
 | 
					          pip install -r requirements.txt
 | 
				
			||||||
 | 
					      - name: Build with Sphinx
 | 
				
			||||||
 | 
					        run: |
 | 
				
			||||||
 | 
					          python -m sphinx -M html docs/source/ docs/build/
 | 
				
			||||||
 | 
					      - name: Upload artifact
 | 
				
			||||||
 | 
					        uses: actions/upload-pages-artifact@v3
 | 
				
			||||||
 | 
					        with:
 | 
				
			||||||
 | 
					          # Upload only the build/html directory
 | 
				
			||||||
 | 
					          path: 'docs/build/html'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  # Deployment job
 | 
				
			||||||
 | 
					  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@v4
 | 
				
			||||||
@ -1,3 +1,6 @@
 | 
				
			|||||||
build
 | 
					build
 | 
				
			||||||
pycryptodome
 | 
					pycryptodome
 | 
				
			||||||
requests
 | 
					requests
 | 
				
			||||||
 | 
					sphinx
 | 
				
			||||||
 | 
					sphinx-book-theme
 | 
				
			||||||
 | 
					myst-parser
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user