diff --git a/.github/workflows/Document_code_wth_sphinx b/.github/workflows/Document_code_wth_sphinx new file mode 100644 index 00000000..e7df64d1 --- /dev/null +++ b/.github/workflows/Document_code_wth_sphinx @@ -0,0 +1,52 @@ +# This is a basic workflow to help you get started with Actions + +name: Build-sphinx-docs + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the main branch + push: + branches: [ master ] + pull_request: + branches: [ master ] + + # 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@v2 + + - name: Set up Python 3.10 + uses: actions/setup-python@v2 + with: + python-version: "3.10" + # Runs a single command using the runners shell + - name: Run a one-line script + run: echo Hello, world! + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Build HTML + run: | + cd docs/ + make html + - name: Run ghp-import + run: | + ghp-import -n -p -f docs/_build/html + + # Runs a set of commands using the runners shell + - name: Run a multi-line script + run: | + echo Add other actions to build, + echo test, and deploy your project.