refactor workflows

.github/workflows/build-and-push-docker.yaml → .github/workflows/ci.yaml

@@ -1,4 +1,4 @@
-name: Build and push Docker image
+name: CI
 
 on:
   schedule:
@@ -14,6 +14,7 @@ on:
 
 jobs:
   test:
+    name: Test
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -33,6 +34,7 @@ jobs:
         run: pytest .
 
   docker:
+    name: Docker
     runs-on: ubuntu-latest
     needs: test
     steps:

.github/workflows/docs.yaml

@@ -0,0 +1,55 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install ".[DOCS]"
+      - name: Build the documentation
+        run: mkdocs build
+
+  deploy:
+    if: github.event_name == 'push'
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install ".[DOCS]"
+      - name: Publish the documentation
+        run: mkdocs gh-deploy --force --dirty

README.md

@@ -2,8 +2,8 @@
 
 <img width=50% src="docs/assets/images/logo.png" alt="Fast-LLM Logo"></img>
 
-[![Docker Build][docker-badge]][docker]
-[![Documentation Build][docs-badge]][docs]
+[![Docker][ci-badge]][ci]
+[![Documentation][docs-badge]][docs]
 [![License][license-badge]][license]
 
 *Accelerating your LLM training to full speed*
@@ -144,10 +144,10 @@ For security issues, email [[email protected]](mailto:psirt-oss@serviceno
 
 [roadmap]: https://github.com/ServiceNow/Fast-LLM/milestones
 [issues]: https://github.com/ServiceNow/Fast-LLM/issues
-[docker-badge]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/build-and-push-docker.yaml/badge.svg
-[docker]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/build-and-push-docker.yaml
-[docs-badge]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/deploy-documentation.yaml/badge.svg
-[docs]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/deploy-documentation.yaml
+[ci-badge]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/ci.yaml/badge.svg
+[ci]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/ci.yaml
+[docs-badge]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/docs.yaml/badge.svg
+[docs]: https://github.com/ServiceNow/Fast-LLM/actions/workflows/docs.yaml
 [license-badge]: https://img.shields.io/badge/License-Apache%202.0-blue.svg
 [license]: LICENSE
 [servicenow-research]: https://www.servicenow.com/research/

setup.cfg

@@ -39,6 +39,15 @@ DEV =
     pytest>=8.3.2
     pytest-depends>=1.0.1
 
+# Required for building the documentation
+DOCS =
+    mkdocs
+    mkdocs-material
+    mkdocs-material[imaging]
+    mkdocs-section-index
+    mkdocstrings[python]
+    mkdocs-git-committers-plugin-2
+    mkdocs-git-revision-date-localized-plugin
 
 [options.entry_points]
 console_scripts =