Update README.md #8
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 is a basic workflow to help you get started with Actions | |
| name: CI | |
| permissions: | |
| contents: write | |
| # Controls when the workflow will run | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the "main" branch | |
| push: | |
| branches: [ "main" ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Set up Python 3.8 | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: 3.8 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Install and run docsify | |
| run: | | |
| npm i docsify-cli -g | |
| echo y | docsify init ./docs/get_started | |
| - name: Build sphinx documentation | |
| run: | | |
| pip install sphinx-rtd-theme | |
| sphinx-apidoc -o docs . | |
| cd docs | |
| sphinx-build -b html . _build/html | |
| cd .. | |
| cp ./docs/get_started/index.html ./docs/_build/html/_static/get_started.html | |
| cp ./docs/get_started/.nojekyll ./docs/_build/html/_static/.nojekyll | |
| cp ./docs/get_started/README.md ./docs/_build/html/_static/README.md | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: docs/_build/html # The folder the action should deploy. |