diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..5402e59 --- /dev/null +++ b/.github/workflows/docs.yml @@ -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 diff --git a/requirements.txt b/requirements.txt index e0be528..a589d8d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -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 diff --git a/requirements_docs.txt b/requirements_docs.txt new file mode 100644 index 0000000..aa04125 --- /dev/null +++ b/requirements_docs.txt @@ -0,0 +1,2 @@ +mkdocs-material==9.5.2 +mkdocs-enumerate-headings-plugin==0.6.1