Skip to content

Commit 7f1acbe

Browse files
Merge pull request #18 from DevoInc/fix/Documentation-workflow
Fix/documentation workflow
2 parents 5571b35 + 7a42f3a commit 7f1acbe

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

.github/workflows/documentation.yml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,22 @@ jobs:
3636
echo "RELEASE_VERSION=${POETRY_VERSION}" >> $GITHUB_ENV
3737
- name: Install dependencies
3838
run: |
39-
pip install sphinx
40-
pip install sphinx-autodoc-typehints
41-
pip install furo
39+
poetry install
4240
- name: Sphinx build
4341
run: |
44-
sphinx-build docs/source _build
45-
- name: Deploy 🚀
42+
poetry run sphinx-build docs/source _build
43+
- name: Deploy version 🚀
4644
uses: peaceiris/actions-gh-pages@v3
4745
with:
4846
github_token: ${{ secrets.GITHUB_TOKEN }}
4947
# deploy the current public folder
50-
# to <base url>/x.y.z version subfolder
48+
# to <base url>/v<x.y.z> version subfolder
5149
publish_dir: ./_build
52-
destination_dir: ${{ env.RELEASE_VERSION }}
50+
destination_dir: v${{ env.RELEASE_VERSION }}
51+
- name: Deploy root 🚀
52+
uses: peaceiris/actions-gh-pages@v3
53+
with:
54+
github_token: ${{ secrets.GITHUB_TOKEN }}
55+
# deploy the current public folder to <base url>
56+
publish_dir: ./_build
57+
keep_files: true

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7+
## [1.0.1] - 2022-10-26
8+
#### Fixed
9+
* Fix documentation workflow.
10+
711
## [1.0.0] - 2022-10-25
812
#### Added
913
* First release.

0 commit comments

Comments
 (0)