[ELITERT-1198] Add action to generate the Sphinx doc #1
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
| # This workflow will generate the Sphinx documentation | |
| name: Sphinx Documentation | |
| on: | |
| push: | |
| branches: [ "master" ] | |
| pull_request: | |
| branches: [ "master" ] | |
| # paths: [ "documentation/**"] | |
| permissions: | |
| contents: read | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install pandoc | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get -y install pandoc | |
| - name: Convert README | |
| run: | | |
| pandoc CHANGELOG.md --from markdown --to rst -s -o documentation/source/introduction/changelog.rst | |
| - name: Install dependencies | |
| working-directory: ./documentation | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Generate Documentation | |
| working-directory: ./documentation | |
| run: | | |
| make html |