Skip to content

Commit

Permalink
(conan-io#13337) [docs] Regenerate tables of contents
Browse files Browse the repository at this point in the history
Co-authored-by: conan-center-bot <conan-center-bot@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and conan-center-bot authored Oct 7, 2022
1 parent 3180533 commit ae6f8ce
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
4 changes: 3 additions & 1 deletion docs/developing_recipes_locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<!-- endToc -->
* [Using Conan 2.0](#using-conan-20)
* [Installing Conan 2.0 beta](#installing-conan-20-beta)
* [Trying it out](#trying-it-out)<!-- endToc -->

## Clone your fork

Expand Down
14 changes: 13 additions & 1 deletion docs/linters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

<!-- toc -->
## Contents<!-- endToc -->
## 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)<!-- endToc -->

## Running the linter locally

Expand Down
4 changes: 2 additions & 2 deletions docs/v2_linter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
<!-- toc -->
## 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)<!-- endToc -->
* [Import tools from `conan`](#import-tools-from-conan)<!-- endToc -->

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
Expand Down

0 comments on commit ae6f8ce

Please sign in to comment.