diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0c60772..f2a2880 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,29 +32,30 @@ jobs: - name: Run the generation pipeline run: sh .github/scripts/generate_types.sh - - uses: actions/setup-python@v4 - with: - python-version: 3.x - - - uses: actions/cache@v2 - with: - path: .cache - key: ${{ github.ref }} - - - run: pip install mkdocs-material jupyter nbconvert mkdocs-jupyter - - - run: mkdocs gh-deploy --force - - name: "Update docs" shell: "bash" run: | if [[ `git status --porcelain` ]]; then - git add ./types - git add ./docs/types + git add --all git config --global user.name 'MD-Models Bot' git config --global user.email 'mdmodels@bot.com' - git commit -am "Docs update" + git commit -am "Doc update" git push else echo "Nothing changed!" fi + + - uses: actions/setup-python@v4 + with: + python-version: 3.x + + - uses: actions/cache@v2 + with: + path: .cache + key: ${{ github.ref }} + + - name: Install dependencies + run: pip install mkdocs-material jupyter nbconvert mkdocs-jupyter + + - name: Deploy Documentation + run: mkdocs gh-deploy --force diff --git a/types/README.md b/types/README.md index 149ac02..f5e0acb 100644 --- a/types/README.md +++ b/types/README.md @@ -1,11 +1,11 @@ # MD-Models Types -This directory contains types that the MD-Models library provides out of the shelf. You can use these types in your own data models by simply referencing them in your data model's attributes `Type` section. +This page contains types that the MD-Models library provides from of the shelf. You can use these types in your own data models by simply referencing them in your data model's attributes `Type` section. ## Types available -- [Unit Definition](./unit-definition) -- [Equation](./equation) +- [Unit Definition](./unit-definition.md) +- [Equation](./equation.md) ## How to use