"...git@developer.sourcefind.cn:OpenDAS/mmdetection3d.git" did not exist on "26a61a99f21581178c3d1b1bee822023ab50be4b"
Commit 74b9627c authored by Wenhao Xie's avatar Wenhao Xie Committed by GitHub
Browse files

[Doc] Create a workflow to host docs using GitHub Pages. (#28)

* [Doc] Use sphinx to generate docs.

* [Doc] Fix a bug on tlcpack_sphinx_addon.

* [Doc] Fix linting issues.

* [Doc] Create a workflow to host docs using GitHub Pages.

* [Doc] Remove all deprecated docs.
parent 157e65bd
name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./docs
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Sphinx build
run: |
make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment