Skip to content

Commit

Permalink
feat: build docs (#138)
Browse files Browse the repository at this point in the history
* feat: build docs

* fix

* fix?

* fix: version
  • Loading branch information
ArzelaAscoIi authored Nov 8, 2023
1 parent 1f35a22 commit a399790
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions .github/workflows/api-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,22 +31,24 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install -r docs/_pydoc/requirements.txt
pip install --upgrade setuptools # Fix to prevent: ModuleNotFoundError: No module named 'pkg_resources'
- name: Generate API docs
run: ./.github/utils/pydoc-markdown.sh

- name: Install dependencies for doc deployment
run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike

- name: Configure git to push docs
run: |
git config --global user.name docs-bot
git config --global user.email [email protected]
git config pull.rebase false
git pull --allow-unrelated-histories origin gh-pages
- name: Install dependencies for doc deployment
run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike

- name: Publish docs
run: |
VERSION=$(sed -n 's/__version__ = "\(.*\)"/\1/p' ./deepset_cloud_sdk/__about__.py) && \
mike deploy --push --update-aliases ${VERSION} && \
mike set-default --push ${VERSION}
mike deploy --push --update-aliases ${{github.ref_name}} && \
mike set-default --push ${{github.ref_name}}
2 changes: 1 addition & 1 deletion deepset_cloud_sdk/__about__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""This file defines the package version."""
# Will be automatically overridden during the release process
# It's okay if this is outdated in the repo. We will use the tag from the release as the version.
__version__ = "0.0.34"
__version__ = "0.0.35"

0 comments on commit a399790

Please sign in to comment.