Skip to content

Commit 1c32c48

Browse files
committed
[Docs] New docs theme based on ESP-IDF style
1 parent 1e388a2 commit 1c32c48

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+129
-168
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ boards.sloeber.txt
2323
# Ignore docs build (Sphinx)
2424
docs/build
2525
docs/source/_build
26+
docs/__pycache__/
27+
docs/_build/
2628

2729
# Test log files
2830
*.log

docs/Makefile

Lines changed: 0 additions & 28 deletions
This file was deleted.
File renamed without changes.

docs/_static/arduino_versions.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
var DOCUMENTATION_VERSIONS = {
2+
DEFAULTS: { has_targets: false,
3+
supported_targets: [ "esp32" ]
4+
},
5+
VERSIONS: [ text: "2.0.3", value: "v2.0.3" ],
6+
IDF_TARGETS: [
7+
{ text: "ESP32", value: "esp32" },
8+
]
9+
};
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/conf_common.py

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
from esp_docs.conf_docs import * # noqa: F403,F401
2+
3+
languages = ["en"]
4+
idf_targets = ["esp32"]
5+
6+
# link roles config
7+
github_repo = "espressif/arduino-esp32"
8+
9+
# context used by sphinx_idf_theme
10+
html_context["github_user"] = "espressif"
11+
html_context["github_repo"] = "arduino-esp32"
12+
13+
html_static_path = ["../_static"]
14+
15+
# Conditional content
16+
17+
extensions += ['sphinx_copybutton',
18+
'sphinx_tabs.tabs',
19+
'esp_docs.esp_extensions.dummy_build_system',
20+
]
21+
22+
ESP32_DOCS = [
23+
"index.rst",
24+
]
25+
26+
conditional_include_dict = {
27+
"esp32": ESP32_DOCS,
28+
}
29+
30+
# Extra options required by sphinx_idf_theme
31+
project_slug = "arduino-esp32"
32+
33+
versions_url = "./_static/arduino_versions.js"

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

Lines changed: 2 additions & 2 deletions

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

Lines changed: 2 additions & 2 deletions

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

Lines changed: 1 addition & 1 deletion

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

Lines changed: 1 addition & 1 deletion

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

Lines changed: 1 addition & 1 deletion

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

Lines changed: 2 additions & 2 deletions
File renamed without changes.

docs/en/conf.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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+
import datetime
11+
12+
try:
13+
from conf_common import * # noqa: F403,F401
14+
except ImportError:
15+
import os
16+
import sys
17+
18+
sys.path.insert(0, os.path.abspath("../"))
19+
from conf_common import * # noqa: F403,F401
20+
21+
# General information about the project.
22+
project = "Arduino-ESP32"
23+
copyright = "2016 - {}, Espressif Systems (Shanghai) Co., Ltd".format(
24+
datetime.datetime.now().year
25+
)
26+
27+
# The language for content autogenerated by Sphinx. Refer to documentation
28+
# for a list of supported languages.
29+
language = "en"

docs/source/getting_started.rst renamed to docs/en/getting_started.rst

Lines changed: 5 additions & 5 deletions

docs/source/guides/docs_contributing.rst renamed to docs/en/guides/docs_contributing.rst

Lines changed: 1 addition & 1 deletion

docs/source/guides/tools_menu.rst renamed to docs/en/guides/tools_menu.rst

Lines changed: 1 addition & 1 deletion

docs/source/installing.rst renamed to docs/en/installing.rst

Lines changed: 15 additions & 15 deletions

docs/source/ota_web_update.rst renamed to docs/en/ota_web_update.rst

Lines changed: 4 additions & 4 deletions

0 commit comments

Comments
 (0)