Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit e4d6a8a

Browse filesBrowse files
pedrominatelpedrominatel
authored
Documentation migration from RTD to ESP-Docs (espressif#9094)
1 parent c1a4055 commit e4d6a8a
Copy full SHA for e4d6a8a

File tree

Expand file treeCollapse file tree

109 files changed

+265
-194
lines changed
Filter options

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Dismiss banner
Expand file treeCollapse file tree

109 files changed

+265
-194
lines changed

‎.github/workflows/docs.yml renamed to ‎.github/workflows/docs_build.yml

Copy file name to clipboard
+10-11Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
name: ReadTheDocs CI
1+
name: Documentation Build and Deploy CI
22

33
on:
4-
push:
5-
branches:
6-
- master
7-
- release/*
8-
paths:
9-
- 'docs/**'
10-
- '.github/workflows/docs.yml'
114
pull_request:
125
paths:
136
- 'docs/**'
@@ -16,7 +9,7 @@ on:
169
jobs:
1710

1811
build-docs:
19-
name: Build ReadTheDocs
12+
name: Build Documentation
2013
runs-on: ubuntu-22.04
2114
defaults:
2215
run:
@@ -34,5 +27,11 @@ jobs:
3427
sudo apt install python3-pip python3-setuptools
3528
# GitHub CI installs pip3 and setuptools outside the path.
3629
# Update the path to include them and run.
37-
PATH=/home/runner/.local/bin:$PATH pip3 install --user -r ./docs/requirements.txt
38-
cd ./docs && PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" make html
30+
cd ./docs
31+
PATH=/home/runner/.local/bin:$PATH pip3 install -r requirements.txt --prefer-binary
32+
PATH=/home/runner/.local/bin:$PATH SPHINXOPTS="-W" build-docs -l en
33+
- name: Archive Docs
34+
uses: actions/upload-artifact@v2
35+
with:
36+
name: docs
37+
path: docs

‎.github/workflows/docs_deploy.yml

Copy file name to clipboard
+46Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Documentation Build and Deploy Production CI
2+
3+
on:
4+
push:
5+
branches:
6+
- release/*
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/docs.yml'
10+
11+
jobs:
12+
13+
deploy-prod-docs:
14+
name: Deploy Documentation Production
15+
runs-on: ubuntu-22.04
16+
defaults:
17+
run:
18+
shell: bash
19+
steps:
20+
- uses: actions/checkout@v2
21+
with:
22+
submodules: true
23+
- uses: actions/setup-python@v2
24+
with:
25+
python-version: '3.10'
26+
- name: Deploy Preview
27+
env:
28+
# Deploy to production server
29+
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
30+
DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_PROD_PRIVATEKEY }}
31+
DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PROD_PATH }}
32+
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_PROD_SERVER }}
33+
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_PROD_URL_BASE }}
34+
DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_PROD_USER }}
35+
run: |
36+
sudo apt update
37+
sudo apt install python3-pip python3-setuptools
38+
source ./docs/utils.sh
39+
add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
40+
export GIT_VER=$(git describe --always)
41+
echo "PIP install requirements..."
42+
pip3 install --user -r ./docs/requirements.txt
43+
echo "Building the Docs..."
44+
cd ./docs && build-docs -l en
45+
echo "Deploy the Docs..."
46+
deploy-docs

‎.github/workflows/docs_preview.yml

Copy file name to clipboard
+46Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Documentation Build and Deploy CI
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/docs.yml'
10+
11+
jobs:
12+
13+
deploy-preview-docs:
14+
name: Deploy Documentation Preview
15+
runs-on: ubuntu-22.04
16+
defaults:
17+
run:
18+
shell: bash
19+
steps:
20+
- uses: actions/checkout@v3
21+
with:
22+
submodules: true
23+
- uses: actions/setup-python@v4
24+
with:
25+
python-version: '3.10'
26+
- name: Deploy Preview
27+
env:
28+
# Deploy to preview server
29+
DOCS_BUILD_DIR: "${CI_PROJECT_DIR}/docs/_build/"
30+
DOCS_DEPLOY_PRIVATEKEY: ${{ secrets.DOCS_KEY }}
31+
DOCS_DEPLOY_PATH: ${{ secrets.DOCS_PATH }}
32+
DOCS_DEPLOY_SERVER: ${{ secrets.DOCS_SERVER }}
33+
DOCS_DEPLOY_URL_BASE: ${{ secrets.DOCS_URL }}
34+
DOCS_DEPLOY_SERVER_USER: ${{ secrets.DOCS_USER }}
35+
run: |
36+
sudo apt update
37+
sudo apt install python3-pip python3-setuptools
38+
source ./docs/utils.sh
39+
add_doc_server_ssh_keys $DOCS_DEPLOY_PRIVATEKEY $DOCS_DEPLOY_SERVER $DOCS_DEPLOY_SERVER_USER
40+
export GIT_VER=$(git describe --always)
41+
echo "PIP install requirements..."
42+
pip3 install --user -r ./docs/requirements.txt
43+
echo "Building the Docs..."
44+
cd ./docs && build-docs -l en
45+
echo "Deploy the Docs..."
46+
deploy-docs

‎docs/Makefile

Copy file name to clipboardExpand all lines: docs/Makefile
-28Lines changed: 0 additions & 28 deletions
This file was deleted.

‎docs/source/_static/arduino-ide.png renamed to ‎docs/_static/arduino-ide.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/arduino_i2c_master.png renamed to ‎docs/_static/arduino_i2c_master.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/arduino_i2c_slave.png renamed to ‎docs/_static/arduino_i2c_slave.png

Copy file name to clipboard
File renamed without changes.

‎docs/_static/arduino_versions.js

Copy file name to clipboard
+16Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
var DOCUMENTATION_VERSIONS = {
2+
DEFAULTS: { has_targets: false,
3+
supported_targets: [ "esp32" ]
4+
},
5+
VERSIONS: [
6+
{ name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c3", "esp32h2", "esp32c6" ] },
7+
],
8+
IDF_TARGETS: [
9+
{ text: "ESP32", value: "esp32"},
10+
{ text: "ESP32-S2", value: "esp32s2"},
11+
{ text: "ESP32-S3", value: "esp32s3"},
12+
{ text: "ESP32-C3", value: "esp32c3"},
13+
{ text: "ESP32-H2", value: "esp32h2"},
14+
{ text: "ESP32-C6", value: "esp32c6"},
15+
]
16+
};

‎docs/source/_static/cross.png renamed to ‎docs/_static/cross.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/esp32-c3_devkitM-1_pinlayout.png renamed to ‎docs/_static/esp32-c3_devkitM-1_pinlayout.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/esp32-s2_saola1_pinlayout.png renamed to ‎docs/_static/esp32-s2_saola1_pinlayout.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/esp32_devkitC_pinlayout.png renamed to ‎docs/_static/esp32_devkitC_pinlayout.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/external_library_test_pr.png renamed to ‎docs/_static/external_library_test_pr.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/external_library_test_schedule.png renamed to ‎docs/_static/external_library_test_schedule.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/gpio_output.png renamed to ‎docs/_static/gpio_output.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/gpio_pullup.png renamed to ‎docs/_static/gpio_pullup.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/green_checkmark.png renamed to ‎docs/_static/green_checkmark.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/install_guide_boards_manager_esp32.png renamed to ‎docs/_static/install_guide_boards_manager_esp32.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/install_guide_boards_manager_url.png renamed to ‎docs/_static/install_guide_boards_manager_url.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/install_guide_preferences.png renamed to ‎docs/_static/install_guide_preferences.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/logo_arduino.png renamed to ‎docs/_static/logo_arduino.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/logo_espressif.png renamed to ‎docs/_static/logo_espressif.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/logo_linux.png renamed to ‎docs/_static/logo_linux.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/logo_macos.png renamed to ‎docs/_static/logo_macos.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/logo_pio.png renamed to ‎docs/_static/logo_pio.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/logo_windows.png renamed to ‎docs/_static/logo_windows.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/ota_esp32_login.png renamed to ‎docs/_static/ota_esp32_login.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/ota_esp32_upload.png renamed to ‎docs/_static/ota_esp32_upload.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/ota_esp32_verbose.png renamed to ‎docs/_static/ota_esp32_verbose.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/ota_export_to_binary.png renamed to ‎docs/_static/ota_export_to_binary.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/soc-module.png renamed to ‎docs/_static/soc-module.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/tutorials/basic/tutorial_basic_ide.png renamed to ‎docs/_static/tutorials/basic/tutorial_basic_ide.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/tutorials/peripherals/tutorial_peripheral_diagram.png renamed to ‎docs/_static/tutorials/peripherals/tutorial_peripheral_diagram.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/usb_msc_drive.png renamed to ‎docs/_static/usb_msc_drive.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/warning.png renamed to ‎docs/_static/warning.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/wifi_esp32_ap.png renamed to ‎docs/_static/wifi_esp32_ap.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/wifi_esp32_sta.png renamed to ‎docs/_static/wifi_esp32_sta.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-1.png renamed to ‎docs/_static/win-gui-1.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-2.png renamed to ‎docs/_static/win-gui-2.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-3.png renamed to ‎docs/_static/win-gui-3.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-4.png renamed to ‎docs/_static/win-gui-4.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-5.png renamed to ‎docs/_static/win-gui-5.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-update-1.png renamed to ‎docs/_static/win-gui-update-1.png

Copy file name to clipboard
File renamed without changes.

‎docs/source/_static/win-gui-update-2.png renamed to ‎docs/_static/win-gui-update-2.png

Copy file name to clipboard
File renamed without changes.

‎docs/conf_common.py

Copy file name to clipboard
+54Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# ---------------------------------------------------------------
2+
3+
from esp_docs.conf_docs import * # noqa: F403,F401
4+
5+
languages = ["en"]
6+
7+
# idf_targets = [
8+
# "esp32",
9+
# "esp32s2",
10+
# "esp32s3",
11+
# "esp32c3",
12+
# "esp32c6",
13+
# "esp32h2",
14+
# ]
15+
16+
# link roles config
17+
github_repo = "espressif/arduino-esp32"
18+
19+
# context used by sphinx_idf_theme
20+
html_context["github_user"] = "espressif"
21+
html_context["github_repo"] = "arduino-esp32"
22+
23+
html_static_path = ["../_static"]
24+
25+
# Conditional content
26+
27+
extensions += ['sphinx_copybutton',
28+
'sphinx_tabs.tabs',
29+
'esp_docs.esp_extensions.dummy_build_system',
30+
]
31+
32+
# ESP32_DOCS = [
33+
# "index.rst",
34+
# ]
35+
36+
# ESP32S2_DOCS = ESP32_DOCS
37+
# ESP32C3_DOCS = ESP32S2_DOCS
38+
# ESP32S3_DOCS = ESP32S2_DOCS
39+
# ESP32C6_DOCS = ESP32S2_DOCS
40+
# ESP32H2_DOCS = ESP32S2_DOCS
41+
42+
# conditional_include_dict = {
43+
# "esp32": ESP32_DOCS,
44+
# "esp32s2": ESP32S2_DOCS,
45+
# "esp32c3": ESP32C3_DOCS,
46+
# "esp32s3": ESP32S3_DOCS,
47+
# "esp32c6": ESP32C6_DOCS,
48+
# "esp32h2": ESP32H2_DOCS,
49+
# }
50+
51+
# Extra options required by sphinx_idf_theme
52+
project_slug = "arduino-esp32"
53+
54+
# versions_url = "./../_static/arduino_versions.js"

‎docs/source/advanced_utils.rst renamed to ‎docs/en/advanced_utils.rst

Copy file name to clipboard

‎docs/source/api/adc.rst renamed to ‎docs/en/api/adc.rst

Copy file name to clipboard

‎docs/source/api/ble.rst renamed to ‎docs/en/api/ble.rst

Copy file name to clipboard

‎docs/source/api/bluetooth.rst renamed to ‎docs/en/api/bluetooth.rst

Copy file name to clipboard

‎docs/source/api/dac.rst renamed to ‎docs/en/api/dac.rst

Copy file name to clipboard

‎docs/source/api/deepsleep.rst renamed to ‎docs/en/api/deepsleep.rst

Copy file name to clipboard

‎docs/source/api/espnow.rst renamed to ‎docs/en/api/espnow.rst

Copy file name to clipboard

‎docs/source/api/ethernet.rst renamed to ‎docs/en/api/ethernet.rst

Copy file name to clipboard

‎docs/source/api/gpio.rst renamed to ‎docs/en/api/gpio.rst

Copy file name to clipboard

‎docs/source/api/i2c.rst renamed to ‎docs/en/api/i2c.rst

Copy file name to clipboardExpand all lines: docs/en/api/i2c.rst
+2-2Lines changed: 2 additions & 2 deletions

‎docs/source/api/i2s.rst renamed to ‎docs/en/api/i2s.rst

Copy file name to clipboard

‎docs/source/api/insights.rst renamed to ‎docs/en/api/insights.rst

Copy file name to clipboard

‎docs/source/api/ledc.rst renamed to ‎docs/en/api/ledc.rst

Copy file name to clipboard

‎docs/source/api/preferences.rst renamed to ‎docs/en/api/preferences.rst

Copy file name to clipboard

‎docs/source/api/pulse_counter.rst renamed to ‎docs/en/api/pulse_counter.rst

Copy file name to clipboard

‎docs/source/api/rainmaker.rst renamed to ‎docs/en/api/rainmaker.rst

Copy file name to clipboard

‎docs/source/api/reset_reason.rst renamed to ‎docs/en/api/reset_reason.rst

Copy file name to clipboard

‎docs/source/api/rmt.rst renamed to ‎docs/en/api/rmt.rst

Copy file name to clipboard

‎docs/source/api/sdio.rst renamed to ‎docs/en/api/sdio.rst

Copy file name to clipboard

‎docs/source/api/sdmmc.rst renamed to ‎docs/en/api/sdmmc.rst

Copy file name to clipboard

‎docs/source/api/sigmadelta.rst renamed to ‎docs/en/api/sigmadelta.rst

Copy file name to clipboard

‎docs/source/api/spi.rst renamed to ‎docs/en/api/spi.rst

Copy file name to clipboard

‎docs/source/api/timer.rst renamed to ‎docs/en/api/timer.rst

Copy file name to clipboard

‎docs/source/api/touch.rst renamed to ‎docs/en/api/touch.rst

Copy file name to clipboard

‎docs/source/api/usb.rst renamed to ‎docs/en/api/usb.rst

Copy file name to clipboard

‎docs/source/api/usb_cdc.rst renamed to ‎docs/en/api/usb_cdc.rst

Copy file name to clipboard

‎docs/source/api/usb_msc.rst renamed to ‎docs/en/api/usb_msc.rst

Copy file name to clipboard

‎docs/source/api/wifi.rst renamed to ‎docs/en/api/wifi.rst

Copy file name to clipboardExpand all lines: docs/en/api/wifi.rst
+2-2Lines changed: 2 additions & 2 deletions

‎docs/source/boards/ESP32-C3-DevKitM-1.rst renamed to ‎docs/en/boards/ESP32-C3-DevKitM-1.rst

Copy file name to clipboardExpand all lines: docs/en/boards/ESP32-C3-DevKitM-1.rst
+1-1Lines changed: 1 addition & 1 deletion

‎docs/source/boards/ESP32-DevKitC-1.rst renamed to ‎docs/en/boards/ESP32-DevKitC-1.rst

Copy file name to clipboardExpand all lines: docs/en/boards/ESP32-DevKitC-1.rst
+1-1Lines changed: 1 addition & 1 deletion

‎docs/source/boards/ESP32-S2-Saola-1.rst renamed to ‎docs/en/boards/ESP32-S2-Saola-1.rst

Copy file name to clipboardExpand all lines: docs/en/boards/ESP32-S2-Saola-1.rst
+1-1Lines changed: 1 addition & 1 deletion

‎docs/source/boards/boards.rst renamed to ‎docs/en/boards/boards.rst

Copy file name to clipboardExpand all lines: docs/en/boards/boards.rst
+2-2Lines changed: 2 additions & 2 deletions

‎docs/source/boards/generic.rst renamed to ‎docs/en/boards/generic.rst

Copy file name to clipboard

‎docs/source/common/datasheet.inc renamed to ‎docs/en/common/datasheet.inc

Copy file name to clipboard
File renamed without changes.

‎docs/en/conf.py

Copy file name to clipboard
+31Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# English Language RTD & Sphinx config file
4+
#
5+
# Uses ../conf_common.py for most non-language-specific settings.
6+
7+
# Importing conf_common adds all the non-language-specific
8+
# parts to this conf module
9+
10+
try:
11+
from conf_common import * # noqa: F403,F401
12+
except ImportError:
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('../'))
16+
from conf_common import * # noqa: F403,F401
17+
18+
import datetime
19+
current_year = datetime.datetime.now().year
20+
21+
# General information about the project.
22+
project = u'Arduino ESP32'
23+
copyright = u'2016 - {}, Espressif Systems (Shanghai) Co., Ltd'.format(current_year)
24+
pdf_title = u'Arduino ESP32 Documentation Guide'
25+
26+
# The language for content autogenerated by Sphinx. Refer to documentation
27+
# for a list of supported languages.
28+
language = 'en'
29+
30+
# Tracking ID for Google Analytics
31+
google_analytics_id = 'G-F58JM78930'

‎docs/source/contributing.rst renamed to ‎docs/en/contributing.rst

Copy file name to clipboard

‎docs/source/esp-idf_component.rst renamed to ‎docs/en/esp-idf_component.rst

Copy file name to clipboard

‎docs/source/external_libraries_test.rst renamed to ‎docs/en/external_libraries_test.rst

Copy file name to clipboardExpand all lines: docs/en/external_libraries_test.rst
+5-5Lines changed: 5 additions & 5 deletions

‎docs/source/faq.rst renamed to ‎docs/en/faq.rst

Copy file name to clipboard

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.