Updating Sphinx docs

branches/master/html/_sources/api/public_api.rst.txt

@@ -159,7 +159,11 @@ Functions
    :cpp:func:`hpx::ranges::is_sorted`                       :cppreference-generic:`algorithm/ranges,is_sorted`
    :cpp:func:`hpx::ranges::is_sorted_until`                 :cppreference-generic:`algorithm/ranges,is_sorted_until`
    :cpp:func:`hpx::ranges::make_heap`                       :cppreference-generic:`algorithm/ranges,make_heap`
+   :cpp:func:`hpx::ranges::max_element`                     :cppreference-generic:`algorithm/ranges,max_element`
    :cpp:func:`hpx::ranges::merge`                           :cppreference-generic:`algorithm/ranges,merge`
+   :cpp:func:`hpx::ranges::min_element`                     :cppreference-generic:`algorithm/ranges,min_element`
+   :cpp:func:`hpx::ranges::minmax_element`                  :cppreference-generic:`algorithm/ranges,minmax_element`
+   :cpp:func:`hpx::ranges::mismatch`                        :cppreference-generic:`algorithm/ranges,mismatch`
    :cpp:func:`hpx::ranges::move`                            :cppreference-generic:`algorithm/ranges,move`
    :cpp:func:`hpx::ranges::none_of`                         :cppreference-generic:`algorithm/ranges,all_any_none_of,none_of`
    :cpp:func:`hpx::ranges::nth_element`                     :cppreference-generic:`algorithm/ranges,nth_element`
@@ -849,6 +853,66 @@ Functions
    | :cpp:func:`hpx::get_locality_name`               |
    +--------------------------------------------------+
 
+.. _public_api_header_hpx_scope:
+
+``hpx/experimental/scope.hpp``
+==============================
+
+The header :hpx-header:`libs/core/include_local/include,hpx/experimental/scope.hpp` corresponds to the
+C++ standard library header :cppreference-header:`experimental/scope`.
+
+Classes
+-------
+
+.. table:: Classes of header ``hpx/scope.hpp``
+
+   ==============================================  ==================================================
+   Class                                           C++ standard
+   ==============================================  ==================================================
+   :cpp:class:`hpx::experimental::scope_exit`      :cppreference-generic:`experimental,scope_exit`
+   :cpp:class:`hpx::experimental::scope_fail`      :cppreference-generic:`experimental,scope_fail`
+   :cpp:class:`hpx::experimental::scope_success`   :cppreference-generic:`experimental,scope_success`
+   ==============================================  ==================================================
+
+.. _public_api_header_hpx_semaphore:
+
+``hpx/semaphore.hpp``
+=====================
+
+The header :hpx-header:`libs/core/include_local/include,hpx/semaphore.hpp` corresponds to the
+C++ standard library header :cppreference-header:`semaphore`.
+
+Classes
+-------
+
+.. table:: Classes of header ``hpx/semaphore.hpp``
+
+   ==========================================  =================================================
+   Class                                       C++ standard
+   ==========================================  =================================================
+   :cpp:class:`hpx::binary_semaphore`          :cppreference-generic:`thread,counting_semaphore`
+   :cpp:class:`hpx::counting_semaphore`        :cppreference-generic:`thread,counting_semaphore`
+   ==========================================  =================================================
+
+.. _public_api_header_hpx_shared_mutex:
+
+``hpx/shared_mutex.hpp``
+========================
+
+The header :hpx-header:`libs/core/include_local/include,hpx/shared_mutex.hpp` corresponds to the
+C++ standard library header :cppreference-header:`shared_mutex`.
+
+Classes
+-------
+
+.. table:: Classes of header ``hpx/shared_mutex.hpp``
+
+   +--------------------------------+---------------------------------------------+
+   | Class                          | C++ standard                                |
+   +================================+=============================================+
+   | :cpp:class:`hpx::shared_mutex` | :cppreference-generic:`thread,shared_mutex` |
+   +--------------------------------+---------------------------------------------+
+
 .. _public_api_header_hpx_source_location:
 
 ``hpx/source_location.hpp``
@@ -868,6 +932,39 @@ Classes
    | :cpp:class:`hpx::source_location` | :cppreference-generic:`utility,source_location` |
    +-----------------------------------+-------------------------------------------------+
 
+.. _public_api_header_hpx_stop_token:
+
+``hpx/stop_token.hpp``
+======================
+
+The header :hpx-header:`libs/core/include_local/include,hpx/stop_token.hpp` corresponds to the
+C++ standard library header :cppreference-header:`stop_token`.
+
+Constants
+---------
+
+.. table:: Constants of header ``hpx/stop_token.hpp``
+
+   +-----------------------------+--------------------------------------------------------+
+   | Constant                    | C++ standard                                           |
+   +=============================+========================================================+
+   | :cpp:var:`hpx::nostopstate` | :cppreference-generic:`thread/stop_source,nostopstate` |
+   +-----------------------------+--------------------------------------------------------+
+
+Classes
+-------
+
+.. table:: Classes of header ``hpx/stop_token.hpp``
+
+   ================================  ========================================================
+   Class                             C++ standard
+   ================================  ========================================================
+   :cpp:class:`hpx::stop_callback`   :cppreference-generic:`thread,stop_callback`
+   :cpp:class:`hpx::stop_source`     :cppreference-generic:`thread,stop_source`
+   :cpp:class:`hpx::stop_token`      :cppreference-generic:`thread,stop_token`
+   :cpp:struct:`hpx::nostopstate_t`  :cppreference-generic:`thread/stop_source,nostopstate_t`
+   ================================  ========================================================
+
 .. _public_api_header_hpx_system_error:
 
 ``hpx/system_error.hpp``
@@ -977,78 +1074,6 @@ Functions
    :cpp:func:`hpx::this_thread::sleep_until`  :cppreference-generic:`thread,sleep_until`
    =========================================  ==========================================
 
-.. _public_api_header_hpx_semaphore:
-
-``hpx/semaphore.hpp``
-=====================
-
-The header :hpx-header:`libs/core/include_local/include,hpx/semaphore.hpp` corresponds to the
-C++ standard library header :cppreference-header:`semaphore`.
-
-Classes
--------
-
-.. table:: Classes of header ``hpx/semaphore.hpp``
-
-   ==========================================  =================================================
-   Class                                       C++ standard
-   ==========================================  =================================================
-   :cpp:class:`hpx::binary_semaphore`          :cppreference-generic:`thread,counting_semaphore`
-   :cpp:class:`hpx::counting_semaphore`        :cppreference-generic:`thread,counting_semaphore`
-   ==========================================  =================================================
-
-.. _public_api_header_hpx_shared_mutex:
-
-``hpx/shared_mutex.hpp``
-========================
-
-The header :hpx-header:`libs/core/include_local/include,hpx/shared_mutex.hpp` corresponds to the
-C++ standard library header :cppreference-header:`shared_mutex`.
-
-Classes
--------
-
-.. table:: Classes of header ``hpx/shared_mutex.hpp``
-
-   +--------------------------------+---------------------------------------------+
-   | Class                          | C++ standard                                |
-   +================================+=============================================+
-   | :cpp:class:`hpx::shared_mutex` | :cppreference-generic:`thread,shared_mutex` |
-   +--------------------------------+---------------------------------------------+
-
-.. _public_api_header_hpx_stop_token:
-
-``hpx/stop_token.hpp``
-======================
-
-The header :hpx-header:`libs/core/include_local/include,hpx/stop_token.hpp` corresponds to the
-C++ standard library header :cppreference-header:`stop_token`.
-
-Constants
----------
-
-.. table:: Constants of header ``hpx/stop_token.hpp``
-
-   +-----------------------------+--------------------------------------------------------+
-   | Constant                    | C++ standard                                           |
-   +=============================+========================================================+
-   | :cpp:var:`hpx::nostopstate` | :cppreference-generic:`thread/stop_source,nostopstate` |
-   +-----------------------------+--------------------------------------------------------+
-
-Classes
--------
-
-.. table:: Classes of header ``hpx/stop_token.hpp``
-
-   ================================  ========================================================
-   Class                             C++ standard
-   ================================  ========================================================
-   :cpp:class:`hpx::stop_callback`   :cppreference-generic:`thread,stop_callback`
-   :cpp:class:`hpx::stop_source`     :cppreference-generic:`thread,stop_source`
-   :cpp:class:`hpx::stop_token`      :cppreference-generic:`thread,stop_token`
-   :cpp:struct:`hpx::nostopstate_t`  :cppreference-generic:`thread/stop_source,nostopstate_t`
-   ================================  ========================================================
-
 .. _public_api_header_hpx_tuple:
 
 ``hpx/tuple.hpp``

branches/master/html/_sources/libs/core/functional/api/full_api.rst.txt

@@ -27,5 +27,8 @@ See :ref:`public_api` for a list of names and headers that are part of the publi
    /libs/core/functional/api/invoke_fused.rst
    /libs/core/functional/api/mem_fn.rst
    /libs/core/functional/api/move_only_function.rst
+   /libs/core/functional/api/scope_exit.rst
+   /libs/core/functional/api/scope_fail.rst
+   /libs/core/functional/api/scope_success.rst
    /libs/core/functional/api/is_bind_expression.rst
    /libs/core/functional/api/is_placeholder.rst

branches/master/html/_sources/libs/core/functional/api/scope_exit.rst.txt

@@ -0,0 +1,20 @@
+
+..
+    Copyright (C) 2022 Dimitra Karatza
+
+    Distributed under the Boost Software License, Version 1.0. (See accompanying
+    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+.. _modules_hpx/functional/experimental/scope_exit.hpp_api:
+
+-------------------------------------------------------------------------------
+hpx::experimental::scope_exit
+-------------------------------------------------------------------------------
+
+Defined in header hpx/experimental/scope.hpp.
+
+See :ref:`public_api` for a list of names and headers that are part of the public
+|hpx| API.
+
+.. autodoxygenfile:: hpx/functional/experimental/scope_exit.hpp
+   :project: functional

branches/master/html/_sources/libs/core/functional/api/scope_fail.rst.txt

@@ -0,0 +1,20 @@
+
+..
+    Copyright (C) 2022 Dimitra Karatza
+
+    Distributed under the Boost Software License, Version 1.0. (See accompanying
+    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+.. _modules_hpx/functional/experimental/scope_fail.hpp_api:
+
+-------------------------------------------------------------------------------
+hpx::experimental::scope_fail
+-------------------------------------------------------------------------------
+
+Defined in header hpx/experimental/scope.hpp.
+
+See :ref:`public_api` for a list of names and headers that are part of the public
+|hpx| API.
+
+.. autodoxygenfile:: hpx/functional/experimental/scope_fail.hpp
+   :project: functional

branches/master/html/_sources/libs/core/functional/api/scope_success.rst.txt

@@ -0,0 +1,20 @@
+
+..
+    Copyright (C) 2022 Dimitra Karatza
+
+    Distributed under the Boost Software License, Version 1.0. (See accompanying
+    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+.. _modules_hpx/functional/experimental/scope_success.hpp_api:
+
+-------------------------------------------------------------------------------
+hpx::experimental::scope_success
+-------------------------------------------------------------------------------
+
+Defined in header hpx/experimental/scope.hpp.
+
+See :ref:`public_api` for a list of names and headers that are part of the public
+|hpx| API.
+
+.. autodoxygenfile:: hpx/functional/experimental/scope_success.hpp
+   :project: functional

branches/master/html/_sources/manual/prerequisites.rst.txt

@@ -56,7 +56,6 @@ The table below presents all the necessary prerequisites for building |hpx|.
    **Build System**       |cmake|_            3.18
    **Required Libraries** |boost|_            1.71.0
    \                      |hwloc|_            1.5
-   \                      |asio|_             1.12.0
    ====================== =================== ==================
 
 The most important dependencies are |boost|_ and |hwloc|_. The installation of Boost

branches/master/html/_sources/quickstart.rst.txt

@@ -11,8 +11,9 @@
 Quick start
 ===========
 
-The following steps will help you get started with |hpx|. After :ref:`installing_hpx`, you
-can check how to run a simple example :ref:`hello_world`. :ref:`writing_task_based_applications`
+The following steps will help you get started with |hpx|. Before getting started, make sure you have
+all the necessary prerequisites, which are listed in :ref:`_prerequisites`. After :ref:`installing_hpx`,
+you can check how to run a simple example :ref:`hello_world`. :ref:`writing_task_based_applications`
 explains how you can get started with |hpx|. You can refer to our :ref:`migration_guide` if you use
 other APIs for parallelism (like |openmp|, |mpi| or |tbb|) and you would like to convert your code to
 |hpx| code.
@@ -25,7 +26,7 @@ Installing |hpx|
 The easiest way to install |hpx| on your system is by choosing one of the steps
 below:
 
-#. **vcpkg**
+#.* * vcpkg * *
 
    You can download and install |hpx| using the `vcpkg
    <https://github.com/Microsoft/vcpkg>`_ dependency manager:
@@ -34,7 +35,7 @@ below:
 
       $ vcpkg install hpx
 
-#. **Spack**
+#.* * Spack * *
 
    Another way to install |hpx| is using
    `Spack <https://spack.readthedocs.io/en/latest/>`_:
@@ -43,7 +44,7 @@ below:
 
       $ spack install hpx
 
-#. **Fedora**
+#.* * Fedora * *
 
    Installation can be done with
    `Fedora <https://fedoraproject.org/wiki/DNF>`_ as well:
@@ -52,7 +53,7 @@ below:
 
       $ dnf install hpx*
 
-#. **Arch Linux**
+#.* * Arch Linux * *
 
    |hpx| is available in the
    `Arch User Repository (AUR) <https://wiki.archlinux.org/title/Arch_User_Repository>`_

branches/master/html/about_hpx.html

@@ -2223,6 +2223,21 @@ <h1 class="site-logo" id="site-title">HPX master documentation</h1>
          hpx::move_only_function
         </a>
        </li>
+       <li class="toctree-l4">
+        <a class="reference internal" href="libs/core/functional/api/scope_exit.html">
+         hpx::experimental::scope_exit
+        </a>
+       </li>
+       <li class="toctree-l4">
+        <a class="reference internal" href="libs/core/functional/api/scope_fail.html">
+         hpx::experimental::scope_fail
+        </a>
+       </li>
+       <li class="toctree-l4">
+        <a class="reference internal" href="libs/core/functional/api/scope_success.html">
+         hpx::experimental::scope_success
+        </a>
+       </li>
        <li class="toctree-l4">
         <a class="reference internal" href="libs/core/functional/api/is_bind_expression.html">
          hpx::is_bind_expression

branches/master/html/about_hpx/history.html

@@ -2223,6 +2223,21 @@ <h1 class="site-logo" id="site-title">HPX master documentation</h1>
          hpx::move_only_function
         </a>
        </li>
+       <li class="toctree-l4">
+        <a class="reference internal" href="../libs/core/functional/api/scope_exit.html">
+         hpx::experimental::scope_exit
+        </a>
+       </li>
+       <li class="toctree-l4">
+        <a class="reference internal" href="../libs/core/functional/api/scope_fail.html">
+         hpx::experimental::scope_fail
+        </a>
+       </li>
+       <li class="toctree-l4">
+        <a class="reference internal" href="../libs/core/functional/api/scope_success.html">
+         hpx::experimental::scope_success
+        </a>
+       </li>
        <li class="toctree-l4">
         <a class="reference internal" href="../libs/core/functional/api/is_bind_expression.html">
          hpx::is_bind_expression