diff --git a/.github/workflows/documentation_site.yml b/.github/workflows/documentation_site.yml index b049894a1..53db840de 100644 --- a/.github/workflows/documentation_site.yml +++ b/.github/workflows/documentation_site.yml @@ -5,33 +5,16 @@ on: - main paths: - docs/** - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -permissions: - contents: write jobs: deploy: runs-on: ubuntu-latest - environment: - name: github-pages - steps: - uses: actions/checkout@v4 - - name: Configure Git Credentials - run: | - git config user.name github-actions[bot] - git config user.email 41898282+github-actions[bot]@users.noreply.github.com - - uses: actions/setup-python@v5 - with: - python-version: 3.13 - - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV - - uses: actions/cache@v4 - with: - key: mkdocs-material-${{ env.cache_id }} - path: .cache - restore-keys: | - mkdocs-material- - - run: pip install mkdocs-material mkdocs-schema-reader mkdocstrings-python markdown-include - - run: mkdocs gh-deploy --force + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CUSTOM_DOMAIN: https://docs.urbanopt.net/geojson-modelica-translator/ + CONFIG_FILE: mkdocs.yml + REQUIREMENTS: docs/docs_requirements.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index 3fb7ff3d8..ef17905b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log +## Version 0.9.1 + +* Fix incorrect link to documentation site by @vtnate + ## Version 0.9.0 ### Exciting New Features 🎉 diff --git a/docs/docs_requirements.txt b/docs/docs_requirements.txt new file mode 100644 index 000000000..3c18a3223 --- /dev/null +++ b/docs/docs_requirements.txt @@ -0,0 +1,4 @@ +markdown-include~=0.8.1 +mkdocs-material~=9.5.49 +mkdocs-schema-reader~=0.11.1 +mkdocstrings-python~=1.12.2" diff --git a/pyproject.toml b/pyproject.toml index 625bf2adc..3709c94ae 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "geojson-modelica-translator" -version = "0.9.0" +version = "0.9.1-rc1" description = "Package for converting GeoJSON to Modelica models for urban scale analyses." authors = ["URBANopt DES Team "] license = "BSD-4-Clause" @@ -55,7 +55,7 @@ pytest = "~7.4" pytest-cov = "~4.1" syrupy = "~4.6" toml = "~0.10" -# documentation +# documentation - these are used during development of docs, not deployment markdown-include = "~0.8.1" mkdocs-material = "~9.5" mkdocs-schema-reader = "~0.11.1"