Skip to content

Commit

Permalink
Add docs workflow (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
gabrielmbmb committed Dec 21, 2023
1 parent 2d6a9a9 commit f1795d0
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
38 changes: 38 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Publish documentation

on:
push:
branches:
- main
- gh-pages
tags:
- "**"

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
# Looks like it's not working very well for other people:
# https://github.com/actions/setup-python/issues/436
# cache: "pip"
# cache-dependency-path: pyproject.toml

- name: Install dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: pip install -e .[docs]
- name: Set git credentials
run: |
git config --global user.name "${{ github.actor }}"
git config --global user.name "${{ github.actor }}@users.noreply.github.com"
- run: mike deploy dev --push
if: github.ref == 'refs/heads/main'

- run: mike deploy latest ${{ github.ref_name }} --push
if: startsWith(github.ref, 'refs/tags/')
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ extra_css:
theme:
name: material
logo: assets/logo.svg
favicon: assets/distilabel-icon.svg
favicon: assets/logo.svg
features:
- navigation.instant
- navigation.tabs
Expand Down

0 comments on commit f1795d0

Please sign in to comment.