From ff3447e0de60bccd891bd3736a2cdbb522fd8cd5 Mon Sep 17 00:00:00 2001 From: me-no-dev Date: Mon, 26 Jul 2021 15:14:56 +0300 Subject: [PATCH 1/4] Check if ReadTheDocs will build --- .github/workflows/docs.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000000..ebf9c7d52da --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,24 @@ +name: ReadTheDocs CI + +on: + push: + branches: + - master + - release/* + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + pull_request: + paths: + - 'docs/**' + - '.github/workflows/docs.yml' + +jobs: + + build-docs: + name: Build ReadTheDocs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: Build + run: cd ./docs && make html From ac5dbe2913768b2efbb5377e7e87081f9b6e2ea1 Mon Sep 17 00:00:00 2001 From: me-no-dev Date: Mon, 26 Jul 2021 15:21:54 +0300 Subject: [PATCH 2/4] Update docs.yml --- .github/workflows/docs.yml | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ebf9c7d52da..e769eff1a6e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,7 +18,21 @@ jobs: build-docs: name: Build ReadTheDocs runs-on: ubuntu-latest + defaults: + run: + shell: bash steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v2 + with: + submodules: true + - uses: actions/setup-python@v2 + with: + python-version: '3.x' - name: Build - run: cd ./docs && make html + run: | + sudo apt update + sudo apt install python3-pip python3-setuptools + # GitHub CI installs pip3 and setuptools outside the path. + # Update the path to include them and run. + PATH=/home/runner/.local/bin:$PATH pip3 install --user -r doc/requirements.txt + cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html From ebe91a4037a0e1ce2417ff471b5ee7a4a458de77 Mon Sep 17 00:00:00 2001 From: me-no-dev Date: Mon, 26 Jul 2021 15:24:09 +0300 Subject: [PATCH 3/4] Update docs.yml --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e769eff1a6e..6110efda7e8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -34,5 +34,5 @@ jobs: sudo apt install python3-pip python3-setuptools # GitHub CI installs pip3 and setuptools outside the path. # Update the path to include them and run. - PATH=/home/runner/.local/bin:$PATH pip3 install --user -r doc/requirements.txt + PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html From 9c70109545e52b43ea8578a0eef5b75a46a07579 Mon Sep 17 00:00:00 2001 From: me-no-dev Date: Mon, 26 Jul 2021 15:55:15 +0300 Subject: [PATCH 4/4] Update conf.py --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 0b9b5fce925..33b42328007 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -56,7 +56,7 @@ # a list of builtin themes. # html_theme = 'default' -html_logo = 'logo_espressif.png' +html_logo = '_static/logo_espressif.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files,