Skip to content

Commit

Permalink
Change to wait for End of Transmission token
Browse files Browse the repository at this point in the history
  • Loading branch information
icarosadero committed May 14, 2023
1 parent f5fcec9 commit 81f3ef2
Show file tree
Hide file tree
Showing 13 changed files with 133 additions and 410 deletions.
64 changes: 28 additions & 36 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,52 +1,44 @@
name: Docs
name: Generate Documentation

on:
push:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-18.04
generate_documentation:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@master
- uses: actions/checkout@v2
with:
token: "${{secrets.TOKEN}}"
- uses: actions/setup-python@v2
- name: Checkout repository
uses: actions/checkout@v2

- name: Setup Python
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.8'
python-version: 3.x

- name: Upgrade pip
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python -m pip install --upgrade pip
python -m pip install -r pyduino/requirements.txt
pip install pydoc-markdown
- name: Get pip cache dir
id: pip-cache
run: echo "::set-output name=dir::$(pip cache dir)"
- name: Generate documentation
run: pydoc-markdown --render-toc -I pyduino -o docs

- name: Install Sphinx
run: python3 -m pip install -U sphinx myst-parser sphinxcontrib-mermaid furo pylint sphinx-autopackagesummary
- name: Configure Git
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
- name: Install dependencies
working-directory: ./pyduino
run: python3 -m pip install -r ./requirements.txt

- name: Run make
working-directory: ./doc/docs
run: make html

- name: Add .nojekyll
working-directory: ./doc/docs/build/html
run: touch .nojekyll

- name: Deploy to gh-pages
uses: s0/git-publish-subdir-action@develop
env:
REPO: self
BRANCH: gh-pages
FOLDER: ./doc/docs/build/html
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Commit changes
run: |
git checkout gh-pages
git add docs
git commit -m "Update documentation"
- name: Push changes
uses: ad-m/[email protected]
with:
branch: gh-pages
20 changes: 0 additions & 20 deletions doc/docs/Makefile

This file was deleted.

1 change: 0 additions & 1 deletion doc/docs/autodoc.sh

This file was deleted.

35 changes: 0 additions & 35 deletions doc/docs/make.bat

This file was deleted.

2 changes: 0 additions & 2 deletions doc/docs/requirements.txt

This file was deleted.

32 changes: 0 additions & 32 deletions doc/docs/source/_templates/custom-class-template.rst

This file was deleted.

66 changes: 0 additions & 66 deletions doc/docs/source/_templates/custom-module-template.rst

This file was deleted.

7 changes: 0 additions & 7 deletions doc/docs/source/_templates/package.rst

This file was deleted.

69 changes: 0 additions & 69 deletions doc/docs/source/conf.py

This file was deleted.

16 changes: 0 additions & 16 deletions doc/docs/source/config-files.rst

This file was deleted.

31 changes: 0 additions & 31 deletions doc/docs/source/index.rst

This file was deleted.

Loading

0 comments on commit 81f3ef2

Please sign in to comment.