alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-08 04:02:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: flake8 fixes

Browse Source
This commit is contained in:
Angus Gratton
2020-02-03 17:38:45 +11:00
committed by Angus Gratton
parent ac8e931179
commit d03af45731
5 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/build_docs.py
View File

@@ -317,6 +317,7 @@ GH_LINK_RE = r"https://github.com/espressif/esp-idf/(?:tree|blob|raw)/[^\s]+"
# we allow this one link, because we always want users to see the latest support policy # we allow this one link, because we always want users to see the latest support policy
GH_LINK_ALLOWED = ["https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY.md"] GH_LINK_ALLOWED = ["https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY.md"]
def action_gh_linkcheck(args): def action_gh_linkcheck(args):
print("Checking for hardcoded GitHub links\n") print("Checking for hardcoded GitHub links\n")

3
docs/conf_common.py
View File

@@ -160,6 +160,7 @@ def update_exclude_patterns(tags):
'api-reference/peripherals/temp_sensor.rst']: 'api-reference/peripherals/temp_sensor.rst']:
exclude_patterns.append(e) exclude_patterns.append(e)
# The reST default role (used for this markup: `text`) to use for all # The reST default role (used for this markup: `text`) to use for all
# documents. # documents.
# default_role = None # default_role = None
@@ -370,9 +371,9 @@ def setup(app):
app.config.breathe_projects = {"esp32-idf": os.path.join(app.config.build_dir, "xml_in/")} app.config.breathe_projects = {"esp32-idf": os.path.join(app.config.build_dir, "xml_in/")}
app.config.breathe_default_project = "esp32-idf" app.config.breathe_default_project = "esp32-idf"
setup_diag_font(app) setup_diag_font(app)
def setup_diag_font(app): def setup_diag_font(app):
# blockdiag and other tools require a font which supports their character set # blockdiag and other tools require a font which supports their character set
# the font file is stored on the download server to save repo size # the font file is stored on the download server to save repo size

1
docs/idf_extensions/gen_idf_tools_links.py
View File

@@ -3,6 +3,7 @@ from __future__ import print_function
import os.path import os.path
from util import copy_if_modified, call_with_python from util import copy_if_modified, call_with_python
def setup(app): def setup(app):
# we don't actually need idf-info, just a convenient event to trigger this on # we don't actually need idf-info, just a convenient event to trigger this on
app.connect('idf-info', generate_idf_tools_links) app.connect('idf-info', generate_idf_tools_links)

1
docs/zh_CN/conf.py
View File

@@ -10,7 +10,6 @@ import sys
import os import os
sys.path.insert(0, os.path.abspath('..')) sys.path.insert(0, os.path.abspath('..'))
from conf_common import * # noqa: F401, F403 - need to make available everything from common from conf_common import * # noqa: F401, F403 - need to make available everything from common
from idf_extensions.util import download_file_if_missing # noqa: E402 - need to import from common folder
# General information about the project. # General information about the project.
project = u'ESP-IDF 编程指南' project = u'ESP-IDF 编程指南'