Skip to content

Commit

Permalink
Added github workflow for building documentation
Browse files Browse the repository at this point in the history
Signed-off-by: MPhalke <[email protected]>
  • Loading branch information
mphalke committed Jan 10, 2024
1 parent 74cc391 commit 747b05a
Show file tree
Hide file tree
Showing 94 changed files with 29 additions and 7,128 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: documentation

on: [push, pull_request, workflow_dispatch]

permissions:
contents: write

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Install dependencies
run: |
python -m pip install sphinx-toolbox
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
run: |
sphinx-build doc/sphinx _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
Binary file removed doc/sphinx/_build/doctrees/environment.pickle
Binary file not shown.
Binary file removed doc/sphinx/_build/doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 0 additions & 4 deletions doc/sphinx/_build/html/.buildinfo

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file removed doc/sphinx/_build/html/_images/app_interface.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed doc/sphinx/_build/html/_images/iio_osc_dmm_tab.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed doc/sphinx/_build/html/_images/iio_osc_tabs.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed doc/sphinx/_build/html/_images/mbed_build.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Binary file removed doc/sphinx/_build/html/_images/stm32_run_option.png
Diff not rendered.
27 changes: 0 additions & 27 deletions doc/sphinx/_build/html/_sources/index.rst.txt

This file was deleted.

35 changes: 0 additions & 35 deletions doc/sphinx/_build/html/_sources/source/contributing.rst.txt

This file was deleted.

This file was deleted.

92 changes: 0 additions & 92 deletions doc/sphinx/_build/html/_sources/source/iio_osc/iio_osc.rst.txt

This file was deleted.

Loading

0 comments on commit 747b05a

Please sign in to comment.