Skip to content

Commit 230a4a5

Browse files
authoredJul 15, 2024
feature(pu): add lightzero sphinx docs (#237)
* feature(pu): add lightzero sphinx docs * feature(pu): add .readthedocs.yaml * polish(pu): move .readthedocs.yaml to the root directory * polish(pu): polish sphinx requirements * polish(pu): polish recommonmark requirements * fix(pu): fix api_doc and use sphinx_rtd_theme * fix(pu): fix .readthedocs.yaml * fix(pu): fix .readthedocs.yaml * fix(pu): fix .readthedocs.yaml * fix(pu): fix conf.py * fix(pu): fix requirements-doc.txt * fix(pu): fix requirements-doc.txt * fix(pu): fix requirements-doc.txt * fix(pu): fix requirements-doc.txt * polish(pu): delete doc/zh_CN * polish(pu): polish conf.py * polish(pu): polish conf.py * polish(pu): polish deploy.yml for docs * fix(pu): Update GitHub Actions workflow and add .nojekyll file * polish(pu): polish deploy.yml for docs * polish(pu): polish deploy.yml for docs * polish(pu): polish deploy.yml for docs * polish(pu): polish deploy.yml for docs * polish(pu): polish deploy.yml for docs * polish(pu): polish deploy.yml for docs * polish(pu): polish documentation
1 parent d2f5ba8 commit 230a4a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+947
-619
lines changed
 

‎.github/workflows/deploy.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Deploy Sphinx Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- dev-doc
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout the repository
14+
uses: actions/checkout@v2
15+
16+
- name: Set up Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: '3.11'
20+
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip
24+
pip install --upgrade -r requirements-doc.txt
25+
pip install -e .
26+
pip install sphinx sphinx-rtd-theme recommonmark
27+
28+
- name: Build the Sphinx documentation
29+
run: |
30+
cd docs/en
31+
make html
32+
cp ../../.nojekyll ./build/html/.nojekyll
33+
34+
- name: Deploy to GitHub Pages
35+
uses: peaceiris/actions-gh-pages@v3
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: ./docs/en/build/html

‎docs/source/_libs/.keep ‎.nojekyll

File renamed without changes.

0 commit comments

Comments
 (0)