Skip to content

Commit fb0e37c

Browse files
czoidoczoido
authored
Remove warning about pre-release version (#3012)
* remove warning * change target branch * output env vars * use inc * inc
1 parent e574c8d commit fb0e37c

25 files changed

+25
-34
lines changed

‎.ci/test.jenkins

+4-1
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@
33
node('Linux') {
44

55
boolean publishDocs = env.BRANCH_NAME.startsWith("release/2.")
6-
def targetBranch = env.CHANGE_BRANCH ? env.CHANGE_BRANCH : env.BRANCH_NAME
6+
def targetBranch = env.CHANGE_TARGET ? env.CHANGE_TARGET : env.BRANCH_NAME
77

88
// We also have to clone conan sources for the sphinx autodoc extension
99
def conanBranch = targetBranch.startsWith("release/2.") ? targetBranch : 'develop2'
1010
def conan_repo_url = 'https://github.com/conan-io/conan.git'
1111

1212
echo "Docs target branch: ${targetBranch}"
1313
echo "Conan target branch: ${conanBranch}"
14+
echo "env.BRANCH_NAME: ${env.BRANCH_NAME}"
15+
echo "env.CHANGE_BRANCH: ${env.CHANGE_BRANCH}"
16+
echo "env.CHANGE_TARGET: ${env.CHANGE_TARGET}"
1417

1518
stage('Clone sources') {
1619
checkout scm

‎common/experimental_warning.rst ‎common/experimental_warning.inc

-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
:orphan:
2-
31
.. warning::
42
This feature is experimental and subject to breaking changes.

‎examples/tools/cmake/cmake_toolchain/build_project_cmake_presets.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The ``CMakePresets.json`` contain information about the ``conan_toolchain.cmake`
4343
and even the ``binaryDir`` set with the output directory.
4444

4545

46-
.. include:: ../../../../tutorial/cmake_presets_note.rst
46+
.. include:: ../../../../tutorial/cmake_presets_note.inc
4747

4848

4949
If you are using a multi-configuration generator:

‎examples/tools/cmake/cmake_toolchain/extend_own_cmake_presets.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ CMakeToolchain: Extending your CMakePresets with Conan generated ones
66
In this example we are going to see how to extend your own CMakePresets to include Conan
77
generated ones.
88

9-
.. include:: ../../../../tutorial/cmake_presets_note.rst
9+
.. include:: ../../../../tutorial/cmake_presets_note.inc
1010

1111
Please, first of all, clone the sources to recreate this project. You can find them in the
1212
`examples2.0 repository <https://github.com/conan-io/examples2>`_ in GitHub:

‎reference/commands/inspect.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
conan inspect
44
=============
55

6-
.. include:: ../../common/experimental_warning.rst
6+
.. include:: ../../common/experimental_warning.inc
77

88
.. code-block:: text
99

‎reference/config_files/profiles.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ List of ``tool_requires`` required by your recipe or its dependencies:
217217
[system_tools]
218218
+++++++++++++++
219219

220-
.. include:: ../../common/experimental_warning.rst
220+
.. include:: ../../common/experimental_warning.inc
221221

222222
This section is similar to the previous one, **[tool_requires]**, but it's intended to list only the tool requires
223223
that are already in your own system and you don't want Conan to search for, neither remotely nor locally.

‎reference/config_files/settings.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ to the ``update`` subsetting in ``settings.yml``.
208208
intel-cc
209209
++++++++
210210

211-
.. include:: ../../common/experimental_warning.rst
211+
.. include:: ../../common/experimental_warning.inc
212212

213213
This compiler is aimed to handle the new Intel oneAPI DPC++/C++/Classic compilers. Instead of having *n* different compilers,
214214
you have 3 different **modes** of working:

‎reference/extensions/python_api/ConanAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Conan API Reference
44
===================
55

6-
.. include:: ../../../common/experimental_warning.rst
6+
.. include:: ../../../common/experimental_warning.inc
77

88
.. currentmodule:: conan.api.conan_api
99

‎reference/extensions/python_api/ConfigAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Config API
22
==========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.config
77

‎reference/extensions/python_api/DownloadAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Download API
22
============
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.download
77

‎reference/extensions/python_api/ExportAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Export API
22
==========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.export
77

‎reference/extensions/python_api/GraphAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Graph API
22
=========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.graph
77

‎reference/extensions/python_api/InstallAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Install API
22
===========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.install
77

‎reference/extensions/python_api/ListAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
List API
22
========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.list
77

‎reference/extensions/python_api/NewAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
New API
22
=======
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.new
77

‎reference/extensions/python_api/ProfilesAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Profiles API
22
============
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.profiles
77

‎reference/extensions/python_api/RemotesAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Remotes API
22
===========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.remotes
77

‎reference/extensions/python_api/RemoveAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Remove API
22
==========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.remove
77

‎reference/extensions/python_api/SearchAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Search API
22
==========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.search
77

‎reference/extensions/python_api/UploadAPI.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Upload API
22
==========
33

4-
.. include:: ../../../common/experimental_warning.rst
4+
.. include:: ../../../common/experimental_warning.inc
55

66
.. currentmodule:: conan.api.subapi.upload
77

‎tutorial.rst

-8
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,6 @@ The purpose of this section is to guide you through the most important Conan fea
88
practical examples. From using libraries already packaged by Conan, to how to package your
99
libraries and store them in a remote server alongside all the precompiled binaries.
1010

11-
.. important::
12-
13-
This tutorial is part of the Conan 2.0 documentation. Conan 2.0 is still in alpha state. Some
14-
details, like the repositories and libraries used for the tutorial, will change as we
15-
update the `current 1.X Conan packages <https://conan.io/center/>`_ to be compatible with
16-
Conan 2.0.
17-
18-
1911
.. toctree::
2012
:maxdepth: 2
2113

‎tutorial/cmake_presets_note.rst ‎tutorial/cmake_presets_note.inc

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
:orphan:
2-
31
.. note::
42

53
We use CMake presets in this example. This requires CMake >= 3.23 because the

‎tutorial/developing_packages/editable_packages.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ depending on the platform and generator used.
7979

8080
Now that the ``say/1.0`` package is in editable mode, let's build it locally:
8181

82-
.. include:: ../cmake_presets_note.rst
82+
.. include:: ../cmake_presets_note.inc
8383

8484
.. code-block:: bash
8585

‎tutorial/developing_packages/local_package_development_flow.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ preset. Let's try it:
241241
You can check that the results of invoking CMake directly are equivalent to the ones we
242242
got using the :command:`conan build` command.
243243

244-
.. include:: ../cmake_presets_note.rst
244+
.. include:: ../cmake_presets_note.inc
245245

246246
conan export-pkg
247247
----------------

‎tutorial/developing_packages/package_layout.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Please, first of all, clone the sources to recreate this project. You can find t
2121
$ git clone https://github.com/conan-io/examples2.git
2222
$ cd examples2/tutorial/developing_packages/package_layout
2323
24-
.. include:: ../cmake_presets_note.rst
24+
.. include:: ../cmake_presets_note.inc
2525

2626
As you can see, the main folder structure is the same:
2727

0 commit comments

Comments
 (0)