Skip to content

Commit 8555f41

Browse files
authored
Document generators_folder (#4147)
1 parent f54dfe6 commit 8555f41

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

reference/conanfile/attributes/folders.inc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ The folder used to build the source code. The path is built joining the base dir
4242
directory when running in the cache or the ``output folder`` when running locally) with
4343
the value of ``folders.build`` if declared in the ``layout()`` method.
4444

45+
46+
.. _attribute_generators_folder:
47+
48+
generators_folder
49+
-----------------
50+
51+
The folder where the files in the ``generate()`` method should be generated. The path is built
52+
from the layout's ``self.folders.generators`` attribute.
53+
4554
.. _conan_conanfile_properties_package_folder:
4655

4756
package_folder

reference/conanfile/methods/generate.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The idea is that the ``generate()`` method implements all the necessary logic, m
2424
very straightforward, and also the ``build()`` method logic simpler. The build produced by a user in their local flow should result in
2525
exactly the same one as the build done in the cache with a ``conan create`` without effort.
2626

27-
Generation of files happens in the ``generators_folder`` as defined by the current layout.
27+
Generation of files happens in the :ref:`generators_folder<attribute_generators_folder>` as defined by the current layout.
2828

2929
In many cases, the ``generate()`` method might not be necessary, and declaring the ``generators`` attribute could be enough:
3030

0 commit comments

Comments
 (0)