From ae6f8ceb954d7754597b8dc1689befdbe239b023 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 7 Oct 2022 09:33:21 +0200 Subject: [PATCH] (#13337) [docs] Regenerate tables of contents Co-authored-by: conan-center-bot --- docs/developing_recipes_locally.md | 4 +++- docs/linters.md | 14 +++++++++++++- docs/v2_linter.md | 4 ++-- 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/developing_recipes_locally.md b/docs/developing_recipes_locally.md index 682ae2dd3e..0ee32ef6f4 100644 --- a/docs/developing_recipes_locally.md +++ b/docs/developing_recipes_locally.md @@ -17,7 +17,9 @@ This file is intended to provide all the commands you need to run in order to be * [Running the Python Linters](#running-the-python-linters) * [Testing the different `test__package`](#testing-the-different-test__package) * [Testing more environments](#testing-more-environments) - * [Using Conan 2.0](#using-conan-20) + * [Using Conan 2.0](#using-conan-20) + * [Installing Conan 2.0 beta](#installing-conan-20-beta) + * [Trying it out](#trying-it-out) ## Clone your fork diff --git a/docs/linters.md b/docs/linters.md index 76db1f45b3..8f4023733d 100644 --- a/docs/linters.md +++ b/docs/linters.md @@ -12,7 +12,19 @@ Also, the Github [code review](https://github.com/features/code-review) is integ parsed by [recipe_linter.json](../linter/recipe_linter.json), then presented to all users on the tab `Files changed`. -## Contents +## Contents + + * [Running the linter locally](#running-the-linter-locally) + * [Pylint configuration files](#pylint-configuration-files) + * [Linter Warning and Errors](#linter-warning-and-errors) + * [E9006 - conan-import-conanfile: ConanFile should be imported from conan](#e9006---conan-import-conanfile-conanfile-should-be-imported-from-conan) + * [E9005 - conan-missing-name: Every conan recipe must contain the attribute name](#e9005---conan-missing-name-every-conan-recipe-must-contain-the-attribute-name) + * [E9004 - conan-package-name: Conan package names must be lower-case](#e9004---conan-package-name-conan-package-names-must-be-lower-case) + * [E9007 - conan-test-no-name: Do not add name attribute in test package recipes](#e9007---conan-test-no-name-do-not-add-name-attribute-in-test-package-recipes) + * [E9008 - conan-import-errors: Deprecated imports should be replaced by new imports](#e9008---conan-import-errors-deprecated-imports-should-be-replaced-by-new-imports) + * [E9009 - conan-import-error-conanexception: conans.errors is deprecated and conan.errors should be used instead](#e9009---conan-import-error-conanexception-conanserrors-is-deprecated-and-conanerrors-should-be-used-instead) + * [E9010 - conan-import-error-conaninvalidconfiguration: conans.errors is deprecated and conan.errors should be used instead](#e9010---conan-import-error-conaninvalidconfiguration-conanserrors-is-deprecated-and-conanerrors-should-be-used-instead) + * [E9011 - conan-import-tools: Importing conan.tools or conan.tools.xxx.zzz.yyy should be considered as private](#e9011---conan-import-tools-importing-conantools-or-conantoolsxxxzzzyyy-should-be-considered-as-private) ## Running the linter locally diff --git a/docs/v2_linter.md b/docs/v2_linter.md index bf0e494551..a2358f657f 100644 --- a/docs/v2_linter.md +++ b/docs/v2_linter.md @@ -3,9 +3,9 @@ ## Contents + * [Running the linter locally](#running-the-linter-locally) * [Import ConanFile from `conan`](#import-conanfile-from-conan) - * [Import tools from `conan`](#import-tools-from-conan) - * [Running the linter locally](#running-the-linter-locally) + * [Import tools from `conan`](#import-tools-from-conan) On our [path to Conan v2](v2_roadmap.md) we are leveraging on custom Pylint rules. This linter will run for every pull-request that is submitted to the repository and will