Skip to content

Commit ccdd3d3

Browse files
committed
docs: update sphinx_idf_theme documentation
Bump CI doc-env docker image to v5
1 parent eeeaba4 commit ccdd3d3

File tree

3 files changed

+2
-26
lines changed

3 files changed

+2
-26
lines changed

.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ variables:
4646
CI_TARGET_TEST_CONFIG_FILE: "$CI_PROJECT_DIR/tools/ci/config/target-test.yml"
4747

4848
# Versioned esp-idf-doc env image to use for all document building jobs
49-
ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v4"
49+
ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v5"
5050

5151

5252
# before each job, we need to check if this job is filtered by bot stage/job filter

docs/en/contribute/documenting-code.rst

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ You can setup environment to build documentation locally on your PC by installin
409409

410410
The package "sphinx_idf_theme" is added to have the same "look and feel" of `ESP-IDF Programming Guide <https://docs.espressif.com/projects/esp-idf/en/latest/index.html>`_.
411411

412-
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.
412+
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.
413413

414414
.. important:: Docs building now supports Python 3 only. Python 2 installations will not work.
415415

@@ -458,22 +458,6 @@ Installation of Doxygen is OS dependent:
458458

459459
A downside of Windows installation is that fonts of the `blockdiag pictures <add-illustrations>` 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.
460460

461-
sphinx_idf_theme
462-
@@@@@@@@@@@@@@@@
463-
464-
The ``sphinx_idf_theme`` needs a mixture of Python and JavaScript in order to build. So currently it's necessary install `node.js <https://nodejs.org/en/download/>`_ in order to build it locally.
465-
466-
::
467-
468-
cd ~/esp
469-
git clone https://github.com/espressif/sphinx_idf_theme.git
470-
cd sphinx_idf_theme
471-
npm install
472-
python setup.py build
473-
python setup.py install
474-
475-
This is a temporary inconvenience. We plan to provide a way to install ``sphinx_idf_theme`` as a prebuilt package, soon.
476-
477461

478462
Remaining applications
479463
@@@@@@@@@@@@@@@@@@@@@@

docs/requirements.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,4 @@ nwdiag==2.0.0
1313
recommonmark
1414
future>=0.16.0 # for ../tools/gen_esp_err_to_name.py
1515
sphinx_selective_exclude==1.0.3
16-
17-
18-
# note: this package is not available on pypi, install by
19-
# downloading from https://github.com/espressif/sphinx_idf_theme then build and
20-
# install (requires node.js also).
21-
#
22-
# See docs/en/contribute/documenting-code.rst, 'sphinx_idf_theme' section
23-
# for full setup instructions.
2416
sphinx_idf_theme==0.2

0 commit comments

Comments
 (0)