From 7a9e80b0ab0b3871f415ef80067a7b61463e28dd Mon Sep 17 00:00:00 2001 From: Igor Udot <47724762+horw@users.noreply.github.com> Date: Thu, 2 Jan 2025 16:34:45 +0800 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61de496..1d7cadd 100644 --- 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 index 8a131a1..a62b267 100644 --- 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"