Skip to content

Commit eeda5fa

Browse files
Merge pull request #42 from pollen-robotics/41-publish-the-doc-on-pages
documentation #41: publish page
2 parents 93f034a + 34f781b commit eeda5fa

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

.github/workflows/docs.yml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,27 @@ jobs:
3636
pip install .[dev]
3737
3838
- name: Generate Documentation
39-
run: pdoc example --output-dir docs
39+
run: pdoc example --output-dir docs --logo "https://pollen-robotics.github.io/python-template/POLLEN_LOGO.png" --logo-link "https://www.pollen-robotics.com"
4040

4141
- name: Archive Documentation
4242
uses: actions/upload-artifact@v4
4343
with:
4444
name: documentation
4545
path: docs/
46+
47+
publish-docs:
48+
needs: build-docs
49+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
50+
runs-on: ubuntu-22.04
51+
steps:
52+
- name: Download Documentation
53+
uses: actions/download-artifact@v4
54+
with:
55+
name: documentation
56+
path: docs/
57+
58+
- name: Deploy to GitHub Pages
59+
uses: peaceiris/actions-gh-pages@v4
60+
with:
61+
github_token: ${{ secrets.GITHUB_TOKEN }}
62+
publish_dir: ./docs

docs/POLLEN_LOGO.png

64.8 KB
Loading

0 commit comments

Comments
 (0)