Skip to content

Commit

Permalink
XZ automate website deployment (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
xiyaozhuang authored Mar 22, 2024
1 parent bb46adf commit 15a7c47
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: documentation

on:
push:
branches:
- main

paths:
- 'mkdocs.yml'
- 'docs/**'
- 'overrides/**'
- '.github/workflows/docs.yml'

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: 3.11.7

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements_docs.txt
- name: Build and deploy documentation
run: |
mkdocs gh-deploy
2 changes: 0 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ langchain==0.0.350
prompttools==0.0.43
llama_cpp_python==0.2.23
sentence-transformers==2.2.2
mkdocs-material==9.5.2
mkdocs-enumerate-headings-plugin==0.6.1
spacy==3.6.1
span-marker==1.5.0
pre-commit==3.6.1
Expand Down
2 changes: 2 additions & 0 deletions requirements_docs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
mkdocs-material==9.5.2
mkdocs-enumerate-headings-plugin==0.6.1

0 comments on commit 15a7c47

Please sign in to comment.