Add many examples to schema and update some descriptions (#394) #135
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: Deploy Documentation | |
| # Controls when the action will run. Triggers the workflow on push | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [ master ] | |
| paths: | |
| - 'src/docs/*' | |
| - 'src/sssom_schema/schema/sssom_schema.yaml' | |
| - 'mkdocs.yml' | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| build-docs: | |
| # 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: | |
| #---------------------------------------------- | |
| # check-out repo and set-up python | |
| #---------------------------------------------- | |
| - name: Check out repository | |
| uses: actions/checkout@v3 | |
| with: | |
| # persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token | |
| fetch-depth: 0 # otherwise, you will failed to push refs to dest repo | |
| - name: Set up Python3 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: 3.9 | |
| #---------------------------------------------- | |
| # install & configure poetry | |
| #---------------------------------------------- | |
| - name: Install Poetry | |
| uses: snok/[email protected] | |
| # with: | |
| # virtualenvs-create: true | |
| # virtualenvs-in-project: true | |
| #---------------------------------------------- | |
| # load cached venv if cache exists | |
| #---------------------------------------------- | |
| - name: Load cached venv | |
| id: cached-poetry-dependencies | |
| uses: actions/cache@v2 | |
| with: | |
| path: .venv | |
| key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }} | |
| #---------------------------------------------- | |
| # install dependencies if cache does not exist | |
| #---------------------------------------------- | |
| - name: Install dependencies | |
| # if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true' | |
| # run: poetry install --no-interaction --no-root | |
| run: poetry install -E docs | |
| #---------------------------------------------- | |
| # install your root project, if required | |
| #---------------------------------------------- | |
| # - name: Install library | |
| # run: poetry install --no-interaction | |
| - name: Create local docs | |
| run: | | |
| mkdir docs | |
| touch docs/.nojekyll | |
| make gendoc | |
| ([ ! -f docs/about.md ] && cp src/docs/about.md docs/) || true | |
| make mkd-gh-deploy |