Merge pull request #173 from espressif/contributing-patch

Update CONTRIBUTING.md
espressif · Jan 2, 2025 · 26fe64d · 26fe64d · github-actions · Jan 2, 2025
2 parents 1eda9e3 + 7a9e80b
commit 26fe64d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -68,7 +68,7 @@ pytest
 We use [sphinx][sphinx] and [autodoc][autodoc] for generating documentation and API references. Besides, we treat warnings as errors while building the documentation. Please fix them before your commits got merged.
 
 ```shell
-cd docs && make html
+cd docs/en && make html
 ```
 
 For documentation preview, you may use any browser you prefer. The executable has to be searchable in `PATH`. For example we're using firefox here.

diff --git a/pyproject.toml b/pyproject.toml
@@ -54,7 +54,7 @@ doc = [
 homepage = "https://github.com/espressif/idf-build-apps"
 repository = "https://github.com/espressif/idf-build-apps"
 documentation = "https://docs.espressif.com/projects/idf-build-apps"
-changelog = "https://github.com/espressif/idf-build-apps/blob/master/CHANGELOG.md"
+changelog = "https://github.com/espressif/idf-build-apps/blob/main/CHANGELOG.md"
 
 [project.scripts]
 idf-build-apps = "idf_build_apps:main.main"
File	Stmts	Miss	Cover	Missing
idf_build_apps
__main__.py	3	3	0%	4–9
app.py	523	81	85%	206, 251, 260–262, 294, 306, 323, 364–365, 368, 378–379, 390–393, 453–458, 478, 516, 572–580, 590–591, 601, 619–620, 622, 638–647, 663–701, 706–707, 711–712, 723–725, 731, 832–840, 850–880, 884–894, 985–991, 994, 1016
args.py	291	33	89%	154, 310, 323, 330, 351–356, 366–371, 537, 540–541, 547, 557–559, 562, 587–588, 591–592, 721–722, 783, 785, 845, 864–874
autocompletions.py	29	24	17%	16–23, 31–54
constants.py	63	9	86%	20–21, 33–38, 47–48, 61–62
finder.py	84	6	93%	79–80, 150, 167–169
log.py	48	4	92%	37, 50, 55, 80
main.py	199	61	69%	76–80, 94–99, 140–144, 174, 198–200, 204, 209–222, 237–240, 251–276, 366–373, 382–383, 405–413, 416, 422–423, 429–431
session_args.py	54	7	87%	46–50, 56, 70
utils.py	188	23	88%	26, 35, 113, 130–131, 151–155, 203, 246, 273–279, 292–295, 314–315, 380
idf_build_apps/junit
report.py	93	9	90%	82, 92, 109–111, 137, 144–145, 170
utils.py	29	10	66%	18, 26–35
idf_build_apps/manifest
if_parser.py	109	5	95%	62, 99, 105, 169, 174
manifest.py	219	9	96%	90, 92, 139, 161, 306, 337–338, 357, 401
idf_build_apps/vendors
pydantic_sources.py	64	6	91%	50, 73, 76–79, 96
TOTAL	2123	290	86%