From 26be41624a70d1e20f9f8432ebddac4ccea38f26 Mon Sep 17 00:00:00 2001 From: "liying@espressif.com" Date: Mon, 18 Sep 2023 15:09:50 +0800 Subject: [PATCH] update the readthedocs yaml file --- .gitlab-ci.yml | 3 ++- .readthedocs.yml | 5 ++++- docs/requirements.txt | 28 ++++++++++++++-------------- docs/sphinx-known-warnings.txt | 4 ++++ 4 files changed, 24 insertions(+), 16 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 9c007547..ede03ce8 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -105,13 +105,14 @@ build_docs: - $BOT_LABEL_BUILD_DOCS - $BOT_LABEL_REGULAR_TEST 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 en - make gh-linkcheck - make html - ../check_doc_warnings.sh - .build_examples_make_template: &build_examples_make_template <<: *build_template # This is a workaround for a rarely encountered issue with building examples in CI. diff --git a/.readthedocs.yml b/.readthedocs.yml index 569fae4c..1b8b6529 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,6 +4,10 @@ # Required version: 2 +build: + os: "ubuntu-16.04" + tools: + python: "3.6" # Optionally build your docs in additional formats such as PDF and ePub formats: @@ -12,6 +16,5 @@ formats: # Optionally set the version of Python and requirements required to build your docs python: - version: 2.7 install: - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index f3884f2e..a5347f52 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,17 +1,17 @@ # This is a list of python packages used to generate documentation. This file is used with pip: # pip install --user -r requirements.txt # -sphinx>=1.8.4 -breathe==4.11.1 -sphinx-rtd-theme -sphinx-notfound-page -sphinxcontrib-blockdiag>=1.5.5, <2.0.0 -sphinxcontrib-seqdiag>=0.8.5, <2.0.0 -sphinxcontrib-actdiag>=0.8.5, <2.0.0 -sphinxcontrib-nwdiag>=0.9.5, <2.0.0 -blockdiag>=1.5.4, <2.0.0 -seqdiag>=0.9.6, <2.0.0 -actdiag>=0.5.4, <2.0.0 -nwdiag>=1.0.4, <2.0.0 -recommonmark -future>=0.16.0 # for ../tools/gen_esp_err_to_name.py +setuptools<57.5.0 +sphinx==2.3.1 +breathe==4.14.1 +sphinx-rtd-theme==1.0.0 +sphinx-notfound-page==0.7.1 +sphinxcontrib-blockdiag==2.0.0 +sphinxcontrib-seqdiag==2.0.0 +sphinxcontrib-actdiag==2.0.0 +sphinxcontrib-nwdiag==2.0.0 +sphinxcontrib-wavedrom==2.0.0 +funcparserlib==0.3.6 +nwdiag==2.0.0 +recommonmark==0.7.0 +future==0.16.0 # for ../tools/gen_esp_err_to_name.py \ No newline at end of file diff --git a/docs/sphinx-known-warnings.txt b/docs/sphinx-known-warnings.txt index 69b3877a..8334d71b 100644 --- a/docs/sphinx-known-warnings.txt +++ b/docs/sphinx-known-warnings.txt @@ -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::mosi 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