Skip to content

Commit

Permalink
fix doc workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
JR-1991 committed Jun 10, 2024
1 parent 6f87c09 commit 29b918d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 19 deletions.
33 changes: 17 additions & 16 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 '[email protected]'
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
6 changes: 3 additions & 3 deletions types/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 29b918d

Please sign in to comment.