Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update sphinx_idf_theme documentation

Browse source 
Bump CI doc-env docker image to v5
This commit is contained in:
Marius Vikhammer 2020-06-19 17:40:26 +08:00
parent eeeaba4b8e
commit ccdd3d3db8
3 changed files with 2 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitlab-ci.yml
View file

@ -46,7 +46,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

18
docs/en/contribute/documenting-code.rst
View file

@ -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 <https://docs.espressif.com/projects/esp-idf/en/latest/index.html>`_.
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 <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.
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 <https://nodejs.org/en/download/>`_ 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
@@@@@@@@@@@@@@@@@@@@@@

8
docs/requirements.txt
View file

@ -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