update documentation #8
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
############################################################ | |
# -*- coding: utf-8 -*- | |
# | |
# # # # # # # | |
# ## ## # ## # # | |
# # # # # # # # # # # | |
# # ## # ## ## ###### | |
# # # # # # # | |
# | |
# Python-based Tool for interaction with the 10micron mounts | |
# GUI with PyQT5 for python3 | |
# | |
# written in python3, (c) 2019-2024 by mworion | |
# Licence APL2.0 | |
# | |
########################################################### | |
name: documentation | |
on: [push, pull_request, workflow_dispatch] | |
permissions: | |
contents: write | |
jobs: | |
documentation: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: Install dependencies | |
run: | | |
pip install sphinx sphinx_rtd_theme alabaster rst2pdf sphinx-copybutton | |
- name: Sphinx build | |
run: | | |
sphinx-build doc doc/build | |
- name: check files | |
run: | | |
ls -la | |
ls -la doc/build | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
if: ${{ github.event_name == 'push'}} | |
with: | |
publish_branch: gh-pages | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: doc/build | |
force_orphan: true |