generated from roboflow/template-python
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #965 from roboflow/ci/doc-test
feat: π add docs test workflow
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |