Skip to content

Commit

Permalink
Merge pull request #965 from roboflow/ci/doc-test
Browse files Browse the repository at this point in the history
feat: πŸ“š add docs test workflow
  • Loading branch information
SkalskiP authored Feb 29, 2024
2 parents 852d518 + 4803ab2 commit 6eeb1c4
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/test-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: πŸ§ͺ Docs Test WorkFlow πŸ“š

on:
pull_request:
branches: [main, develop]

jobs:
docs-build-test:
runs-on: ubuntu-latest
steps:
- name: πŸ”„ Checkout code
uses: actions/checkout@v4
- name: 🐍 Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: πŸ“¦ Install mkdocs-material
run: pip install "mkdocs-material[all]"
- name: πŸ“¦ Install mkdocstrings[python]
run: pip install "mkdocstrings[python]"
- name: πŸ“¦ Install mkdocs-material[imaging]
run: pip install "mkdocs-material[imaging]"
- name: πŸ“¦ Install mike
run: pip install "mike"
- name: πŸ“¦ Install mkdocs-git-revision-date-localized-plugin
run: pip install "mkdocs-git-revision-date-localized-plugin"
- name: πŸ“¦ Install JupyterLab
run: pip install jupyterlab
- name: πŸ“¦ Install mkdocs-jupyter
run: pip install mkdocs-jupyter
- name: πŸ“¦ Install mkdocs-git-committers-plugin-2
run: pip install mkdocs-git-committers-plugin-2
- name: πŸ§ͺ Test documentation build
run: mkdocs build --verbose

0 comments on commit 6eeb1c4

Please sign in to comment.