File tree Expand file tree Collapse file tree 5 files changed +40
-16
lines changed
Filter options
Expand file tree Collapse file tree 5 files changed +40
-16
lines changed
Original file line number Diff line number Diff line change 1
1
name : Documentation Build and Deploy CI
2
2
3
3
on :
4
+ push :
5
+ branches :
6
+ - master
7
+ - release/*
8
+ paths :
9
+ - ' docs/**'
10
+ - ' .github/workflows/docs.yml'
4
11
pull_request :
5
12
paths :
6
13
- ' docs/**'
9
16
jobs :
10
17
11
18
build-docs :
12
- name : Build Documentation
19
+ name : Build ESP-Docs
13
20
runs-on : ubuntu-22.04
14
21
defaults :
15
22
run :
35
42
with :
36
43
name : docs
37
44
path : docs
45
+
Original file line number Diff line number Diff line change 1
- name : Documentation Build and Deploy Production CI
1
+ name : Documentation Build and Production Deploy CI
2
2
3
3
on :
4
4
push :
11
11
jobs :
12
12
13
13
deploy-prod-docs :
14
- name : Deploy Documentation Production
14
+ name : Deploy Documentation on Production
15
15
runs-on : ubuntu-22.04
16
16
defaults :
17
17
run :
18
18
shell : bash
19
19
steps :
20
- - uses : actions/checkout@v2
20
+ - uses : actions/checkout@v3
21
21
with :
22
22
submodules : true
23
- - uses : actions/setup-python@v2
23
+ - uses : actions/setup-python@v4
24
24
with :
25
25
python-version : ' 3.10'
26
- - name : Deploy Preview
26
+ - name : Deploy Documentation
27
27
env :
28
28
# Deploy to production server
29
- DOCS_BUILD_DIR : " ${CI_PROJECT_DIR} /docs/_build/"
29
+ # DOCS_BUILD_DIR: ". /docs/_build/"
30
30
DOCS_DEPLOY_PRIVATEKEY : ${{ secrets.DOCS_PROD_PRIVATEKEY }}
31
31
DOCS_DEPLOY_PATH : ${{ secrets.DOCS_PROD_PATH }}
32
- DOCS_DEPLOY_SERVER : ${{ secrets.DOCS_PROD_SERVER }}
33
- DOCS_DEPLOY_URL_BASE : ${{ secrets.DOCS_PROD_URL_BASE }}
32
+ DOCS_DEPLOY_SERVER : ${{ secrets.DOCS_SERVER }}
34
33
DOCS_DEPLOY_SERVER_USER : ${{ secrets.DOCS_PROD_USER }}
34
+ DOCS_DEPLOY_URL_BASE : ${{ secrets.DOCS_PROD_URL_BASE }}
35
+ # Deploy to preview server
35
36
run : |
36
37
sudo apt update
37
38
sudo apt install python3-pip python3-setuptools
43
44
echo "Building the Docs..."
44
45
cd ./docs && build-docs -l en
45
46
echo "Deploy the Docs..."
47
+ export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
48
+ cd $GITHUB_WORKSPACE/docs
46
49
deploy-docs
Original file line number Diff line number Diff line change 1
- name : Documentation Build and Deploy CI
1
+ name : Documentation Build and Preview Deploy CI
2
2
3
3
on :
4
4
push :
11
11
jobs :
12
12
13
13
deploy-preview-docs :
14
- name : Deploy Documentation Preview
14
+ name : Deploy Documentation
15
15
runs-on : ubuntu-22.04
16
16
defaults :
17
17
run :
@@ -26,12 +26,12 @@ jobs:
26
26
- name : Deploy Preview
27
27
env :
28
28
# Deploy to preview server
29
- DOCS_BUILD_DIR : " ${CI_PROJECT_DIR} /docs/_build/ "
29
+ # DOCS_BUILD_DIR: ". /docs/_build"
30
30
DOCS_DEPLOY_PRIVATEKEY : ${{ secrets.DOCS_KEY }}
31
31
DOCS_DEPLOY_PATH : ${{ secrets.DOCS_PATH }}
32
32
DOCS_DEPLOY_SERVER : ${{ secrets.DOCS_SERVER }}
33
- DOCS_DEPLOY_URL_BASE : ${{ secrets.DOCS_URL }}
34
33
DOCS_DEPLOY_SERVER_USER : ${{ secrets.DOCS_USER }}
34
+ DOCS_DEPLOY_URL_BASE : ${{ secrets.DOCS_URL }}
35
35
run : |
36
36
sudo apt update
37
37
sudo apt install python3-pip python3-setuptools
43
43
echo "Building the Docs..."
44
44
cd ./docs && build-docs -l en
45
45
echo "Deploy the Docs..."
46
+ export DOCS_BUILD_DIR=$GITHUB_WORKSPACE/docs/
47
+ cd $GITHUB_WORKSPACE/docs
46
48
deploy-docs
Original file line number Diff line number Diff line change 1
1
# Arduino core for the ESP32, ESP32-S2, ESP32-S3, ESP32-C3, ESP32-C6 and ESP32-H2
2
2
3
- ![ Build Status] ( https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg ) [ ![ Documentation Status] ( https://readthedocs.com/projects/espressif-arduino-esp32/badge/?version=latest )] ( https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest )
4
- [ ![ External Libraries Test] ( https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml/badge.svg?branch=master&event=schedule )] ( https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md )
3
+ ![ Build Status] ( https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg ) [ ![ External Libraries Test] ( https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml/badge.svg?branch=master&event=schedule )] ( https://github.com/espressif/arduino-esp32/actions/workflows/lib.yml?link=http://https://github.com/espressif/arduino-esp32/blob/master/LIBRARIES_TEST.md )
5
4
6
5
### Need help or have a question? Join the chat at [ Gitter] ( https://gitter.im/espressif/arduino-esp32 ) or [ open a new Discussion] ( https://github.com/espressif/arduino-esp32/discussions )
7
6
Original file line number Diff line number Diff line change 1
1
esp-docs == 1.4.*
2
2
sphinx-copybutton == 0.5.0
3
- sphinx-tabs == 3.2.0
3
+ sphinx-tabs == 3.2.0
4
+ sphinxcontrib-actdiag == 3.0.0
5
+ sphinxcontrib-applehelp == 1.0.4
6
+ sphinxcontrib-blockdiag == 3.0.0
7
+ sphinxcontrib-devhelp == 1.0.2
8
+ sphinxcontrib-htmlhelp == 2.0.1
9
+ sphinxcontrib-jsmath == 1.0.1
10
+ sphinxcontrib-nwdiag == 2.0.0
11
+ sphinxcontrib-qthelp == 1.0.3
12
+ sphinxcontrib-seqdiag == 3.0.0
13
+ sphinxcontrib-serializinghtml == 1.1.5
14
+ sphinxcontrib-svg2pdfconverter == 1.2.0
15
+ sphinxcontrib-wavedrom == 3.0.4
You can’t perform that action at this time.
0 commit comments