From 61904135b30522e5d987ab85c0da7ed1f42ed3d1 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Fri, 19 Jun 2020 17:40:26 +0800 Subject: [PATCH] docs: update sphinx_idf_theme documentation Bump CI doc-env docker image to v5 --- .gitlab-ci.yml | 2 +- docs/en/contribute/documenting-code.rst | 18 +----------------- docs/requirements.txt | 8 -------- 3 files changed, 2 insertions(+), 26 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 48374788b..4d65439b1 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -45,7 +45,7 @@ variables: CI_TARGET_TEST_CONFIG_FILE: "$CI_PROJECT_DIR/tools/ci/config/target-test.yml" # Versioned esp-idf-doc env image to use for all document building jobs - ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v4" + ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v5" # before each job, we need to check if this job is filtered by bot stage/job filter diff --git a/docs/en/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst index 896b1f963..1d593e1dd 100644 --- a/docs/en/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -409,7 +409,7 @@ You can setup environment to build documentation locally on your PC by installin The package "sphinx_idf_theme" is added to have the same "look and feel" of `ESP-IDF Programming Guide `_. -Do not worry about being confronted with several packages to install. Besides Doxygen and sphinx_idf_theme, all remaining packages are written in pure Python. Therefore installation of all of them is combined into one simple step. +Do not worry about being confronted with several packages to install. Besides Doxygen, all remaining packages are written in pure Python. Therefore installation of all of them is combined into one simple step. .. important:: Docs building now supports Python 3 only. Python 2 installations will not work. @@ -458,22 +458,6 @@ Installation of Doxygen is OS dependent: A downside of Windows installation is that fonts of the `blockdiag pictures ` do not render correctly, you will see some random characters instead. Until this issue is fixed, you can use the `interactive shell`_ to see how the complete picture looks like. -sphinx_idf_theme -@@@@@@@@@@@@@@@@ - -The ``sphinx_idf_theme`` needs a mixture of Python and JavaScript in order to build. So currently it's necessary install `node.js `_ in order to build it locally. - -:: - - cd ~/esp - git clone https://github.com/espressif/sphinx_idf_theme.git - cd sphinx_idf_theme - npm install - python setup.py build - python setup.py install - -This is a temporary inconvenience. We plan to provide a way to install ``sphinx_idf_theme`` as a prebuilt package, soon. - Remaining applications @@@@@@@@@@@@@@@@@@@@@@ diff --git a/docs/requirements.txt b/docs/requirements.txt index 7aa074755..162321c08 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -13,12 +13,4 @@ nwdiag==2.0.0 recommonmark future>=0.16.0 # for ../tools/gen_esp_err_to_name.py sphinx_selective_exclude==1.0.3 - - -# note: this package is not available on pypi, install by -# downloading from https://github.com/espressif/sphinx_idf_theme then build and -# install (requires node.js also). -# -# See docs/en/contribute/documenting-code.rst, 'sphinx_idf_theme' section -# for full setup instructions. sphinx_idf_theme==0.2