Skip to content

Commit da1383b

Browse files
committed
Merge branch 'master' into develop
2 parents 1ebbe2a + 61ad313 commit da1383b

File tree

7 files changed

+21
-14
lines changed

7 files changed

+21
-14
lines changed

conf.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,12 @@
5959

6060
html_context = {
6161
"versions": versions_dict,
62-
"current_version": version
62+
"current_version": version,
63+
"display_github": True, # Integrate GitHub
64+
"github_user": "conan-io", # Username
65+
"github_repo": "docs", # Repo name
66+
"github_version": "master", # Version
67+
"conf_py_path": "/" # Path in the checkout to the docs root
6368
}
6469

6570
# Add any paths that contain templates here, relative to this directory.

extending/plugins.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ And it can be used in plugin importing the module:
142142
Storage, activation and sharing
143143
-------------------------------
144144

145-
Plugins are Python files stored under *~/.conan/plugins* folder and their file name should be the same used for activation.
145+
Plugins are Python files stored under *~/.conan/plugins* folder and **their file name should be the same used for activation** (without the
146+
*.py* extension).
146147

147148
The activation of the plugins is done in the *conan.conf* section named ``[plugins]``. The plugin names listed under this section will be
148149
considered activated.

mastering/conditional.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ There are two approaches for this situation:
6666
6767
def configure(self):
6868
if self.settings.os == "Windows":
69-
raise ConanException("This library is not compatible with Windows")
69+
raise ConanInvalidConfiguration("This library is not compatible with Windows")
7070
7171
This same method is also valid for ``options`` and ``config_options()`` method and it is commonly used to remove options for one setting:
7272

reference/build_helpers/cmake.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The CMake helper will automatically append some definitions based on your settin
139139
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
140140
| CONAN_CMAKE_FIND_ROOT_PATH_MODE_INCLUDE | Definition only set if same environment variable is declared by user |
141141
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
142-
| CONAN_CMAKE_POSITION_INDEPENDENT_CODE | When ``fPIC`` option is present and True or when ``fPIC`` is present and False but and option ``shared`` is present and True|
142+
| CONAN_CMAKE_POSITION_INDEPENDENT_CODE | When ``fPIC`` option is present and True or when ``fPIC`` is present and False but option ``shared`` is present and True |
143143
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
144144
| CONAN_SHARED_LINKER_FLAGS | -m32 and -m64 based on your architecture |
145145
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+

reference/conanfile/attributes.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -349,15 +349,15 @@ consistent implementation take into account these considerations:
349349
- equals ``False`` for the values ``False``, ``"False"`` and ``"false"``, also for the empty
350350
string and for ``0`` and ``"0"`` as expected.
351351

352-
- Comparaison using ``is`` is always equals to ``False`` because the types would be different as
352+
- Comparison using ``is`` is always equals to ``False`` because the types would be different as
353353
the option value is encapsulated inside a Conan class.
354354

355-
- Explicit comparaisons with the ``==`` symbol **are case sensitive**, so:
355+
- Explicit comparisons with the ``==`` symbol **are case sensitive**, so:
356356

357357
- ``self.options.option = "False"`` satisfies ``assert self.options.option == False``,
358358
``assert self.options.option == "False"``, but ``assert self.options.option != "false"``.
359359

360-
- A different behaviour has ``self.options.option = None``, because
360+
- A different behavior has ``self.options.option = None``, because
361361
``assert self.options.option != None``.
362362

363363

@@ -366,21 +366,21 @@ consistent implementation take into account these considerations:
366366
default_options
367367
---------------
368368

369-
As you have seen in the examples above, recipe's default options can be assigned to the desired value. However, you can also specify
370-
default option values of the required dependencies:
369+
As you have seen in the examples above, recipe's default options are declared as a dictionary with the initial desired value of the options.
370+
However, you can also specify default option values of the required dependencies:
371371

372372
.. code-block:: python
373373
374374
class OtherPkg(ConanFile):
375375
requires = "Pkg/0.1@user/channel"
376-
default_options = "Pkg:pkg_option=value"
376+
default_options = {"Pkg:pkg_option": "value"}
377377
378378
And it also works with default option values of conditional required dependencies:
379379

380380
.. code-block:: python
381381
382382
class OtherPkg(ConanFile):
383-
default_options = "Pkg:pkg_option=value"
383+
default_options = {"Pkg:pkg_option": "value"}
384384
385385
def requirements(self):
386386
if self.settings.os != "Windows":

reference/conanfile/methods.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -419,6 +419,7 @@ it is an example of a recipe for a library that doesn't support Windows operatin
419419
if self.settings.os == "Windows":
420420
raise ConanInvalidConfiguration("Library MyLib is only supported for Windows")
421421
422+
This exception will be propagated and Conan application will exit with the error code ``6``.
422423

423424
requirements()
424425
--------------

reference/plugins.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ subsequent **pre**/**post** ``download_package()``/``upload_package()`` if that
146146
using :command:`conan create` or :command:`conan install`.
147147

148148
Function parameters
149-
--------------------
149+
-------------------
150150

151151
Here you can find the description for each parameter:
152152

@@ -193,14 +193,14 @@ Table legend:
193193
- **post**: Only available in ``post`` function.
194194
- **cache**: Only available when the context of the command executed is the local cache. e.g. :command:`conan create`,
195195
:command:`conan install`...
196-
- **user space**: Only available when the context of the command executed is the local cache. e.g. :command:`conan build`
196+
- **user space**: Only available when the context of the command executed is the user space. e.g. :command:`conan build`
197197

198198
.. note::
199199

200200
Path to the different folders of the Conan execution flow may be accessible as usual through the ``conanfile`` object. See
201201
:ref:`folders_attributes_reference` to learn more.
202202

203-
Some of this parameters does not appear in the signature of the function as they may not be available always (Mostly depending on the recipe
203+
Some of this parameters does not appear in the signature of the function as they may not be always available (Mostly depending on the recipe
204204
living in the local cache or in user space). However, they can be checked with the ``kwargs`` parameter.
205205

206206
.. important::

0 commit comments

Comments
 (0)