conan runner docs added

conan-io · Apr 29, 2024 · 61d94f4 · 61d94f4
1 parent 9bc916b
commit 61d94f4
Show file tree

Hide file tree

Showing 3 changed files with 546 additions and 0 deletions.
diff --git a/reference.rst b/reference.rst
@@ -17,3 +17,4 @@ Reference
    reference/environment
    reference/binary_model
    reference/conan_server
+   reference/runners
diff --git a/reference/runners.rst b/reference/runners.rst
@@ -0,0 +1,17 @@
+.. _reference_runners:
+
+Runners
+=======
+
+Runners are the way to run conan remotely and transparently just by modifying the host profile. There are three requirements to be able to use the requirements:
+
+- Installing a version of conan with runner dependencies ``pip install conan[runners]``. 
+- Install the tools to run each of the runners (``docker``, ``ssh``, ``wsl``).
+- Add to the ``host profile`` the ``[runner]`` section defined in the documentation of each runner.
+
+Runners:
+
+.. toctree::
+    :maxdepth: 1
+
+    runners/docker