espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-07-05 00:16:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

update the readthedocs yaml file

Browse Source
This commit is contained in:
liying@espressif.com
2023-09-18 15:09:50 +08:00
parent 821caea387
commit 26be41624a
4 changed files with 24 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitlab-ci.yml
View File

@ -105,13 +105,14 @@ build_docs:
- $BOT_LABEL_BUILD_DOCS - $BOT_LABEL_BUILD_DOCS
- $BOT_LABEL_REGULAR_TEST - $BOT_LABEL_REGULAR_TEST
script: script:
- source /opt/pyenv/activate && pyenv global 3.6.10
- /opt/pyenv/pyenv-1.2.16/versions/3.6.10/bin/python -m pip install --user -r $CI_PROJECT_DIR/docs/requirements.txt
- cd docs - cd docs
- cd en - cd en
- make gh-linkcheck - make gh-linkcheck
- make html - make html
- ../check_doc_warnings.sh - ../check_doc_warnings.sh
.build_examples_make_template: &build_examples_make_template .build_examples_make_template: &build_examples_make_template
<<: *build_template <<: *build_template
# This is a workaround for a rarely encountered issue with building examples in CI. # This is a workaround for a rarely encountered issue with building examples in CI.

5
.readthedocs.yml
View File

@ -4,6 +4,10 @@
# Required # Required
version: 2 version: 2
build:
os: "ubuntu-16.04"
tools:
python: "3.6"
# Optionally build your docs in additional formats such as PDF and ePub # Optionally build your docs in additional formats such as PDF and ePub
formats: formats:
@ -12,6 +16,5 @@ formats:
# Optionally set the version of Python and requirements required to build your docs # Optionally set the version of Python and requirements required to build your docs
python: python:
version: 2.7
install: install:
- requirements: docs/requirements.txt - requirements: docs/requirements.txt

28
docs/requirements.txt
View File

@ -1,17 +1,17 @@
# This is a list of python packages used to generate documentation. This file is used with pip: # This is a list of python packages used to generate documentation. This file is used with pip:
# pip install --user -r requirements.txt # pip install --user -r requirements.txt
# #
sphinx>=1.8.4 setuptools<57.5.0
breathe==4.11.1 sphinx==2.3.1
sphinx-rtd-theme breathe==4.14.1
sphinx-notfound-page sphinx-rtd-theme==1.0.0
sphinxcontrib-blockdiag>=1.5.5, <2.0.0 sphinx-notfound-page==0.7.1
sphinxcontrib-seqdiag>=0.8.5, <2.0.0 sphinxcontrib-blockdiag==2.0.0
sphinxcontrib-actdiag>=0.8.5, <2.0.0 sphinxcontrib-seqdiag==2.0.0
sphinxcontrib-nwdiag>=0.9.5, <2.0.0 sphinxcontrib-actdiag==2.0.0
blockdiag>=1.5.4, <2.0.0 sphinxcontrib-nwdiag==2.0.0
seqdiag>=0.9.6, <2.0.0 sphinxcontrib-wavedrom==2.0.0
actdiag>=0.5.4, <2.0.0 funcparserlib==0.3.6
nwdiag>=1.0.4, <2.0.0 nwdiag==2.0.0
recommonmark recommonmark==0.7.0
future>=0.16.0 # for ../tools/gen_esp_err_to_name.py future==0.16.0 # for ../tools/gen_esp_err_to_name.py

4
docs/sphinx-known-warnings.txt
View File

@ -86,3 +86,7 @@ spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::cmd
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::addr spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::addr
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::mosi spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::mosi
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::miso spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::miso
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::cmd : 5
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::addr : 7
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::mosi : 10
spi.inc:line: WARNING: Duplicate declaration, uint32_t spi_trans_t::miso : 10