Help updated 2 #175
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
| name: documentation check | |
| on: | |
| push: | |
| pull_request: | |
| branches: [ "master", "dev" , "experimental" ] | |
| jobs: | |
| readme_check: | |
| name: Readme check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/make_doc.py README.tmp | |
| - name: Compare temp file with readme.rst | |
| run: diff -u --strip-trailing-cr README.rst README.tmp | |
| hon_examples_check: | |
| name: Check hon_example | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/process_examples.py docs/examples/hon_example.rst docs/hon_example.tmp | |
| - name: Compare temp file with hon_example.rst | |
| run: diff -u --strip-trailing-cr docs/hon_example.rst docs/hon_example.tmp | |
| smartair2_examples_check: | |
| name: Check smartair2_example | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/process_examples.py docs/examples/smartair2_example.rst docs/smartair2_example.tmp | |
| - name: Compare temp file with smartair2_example.rst | |
| run: diff -u --strip-trailing-cr docs/smartair2_example.rst docs/smartair2_example.tmp | |
| usb_2_uart_boards: | |
| name: Check usb_2_uart_boards | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/process_examples.py docs/examples/usb_2_uart_boards.rst docs/usb_2_uart_boards.tmp | |
| - name: Compare temp file with usb_2_uart_boards.rst | |
| run: diff -u --strip-trailing-cr docs/usb_2_uart_boards.rst docs/usb_2_uart_boards.tmp | |
| sniffing_serial_communication: | |
| name: Check sniffing_serial_communication | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/process_examples.py docs/examples/sniffing_serial_communication.rst docs/sniffing_serial_communication.tmp | |
| - name: Compare temp file with sniffing_serial_communication.rst | |
| run: diff -u --strip-trailing-cr docs/sniffing_serial_communication.rst docs/sniffing_serial_communication.tmp | |
| climate_haier_doc: | |
| name: Check ESPHome climate haier | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/[email protected] | |
| - name: Run script and save results | |
| run: python docs/script/process_examples.py docs/examples/climate_haier.rst docs/climate_haier.tmp no_header | |
| - name: Compare temp file with ESPHome climate haier | |
| run: diff -u --strip-trailing-cr docs/climate_haier.tmp docs/esphome-docs/climate/haier.rst |