Merge #6359 #6360

6359: Fix header file links in Public API page r=hkaiser a=dimitraka

Follow up on #6354

6360: Fix broken links in docs: PDF, Single HTML page, Dependency report r=hkaiser a=dimitraka

Towards resolving #6355

Co-authored-by: dimitraka <[email protected]>

cmake/templates/conf.py.in

@@ -275,11 +275,11 @@ rst_prolog += '''
     :target: https://joss.theoj.org/papers/022e5917b95517dff20cd3742ab95eca
     :alt: JOSS Paper about HPX
 .. |hpx_dependency_report| replace:: |hpx| Dependency report
-.. _hpx_dependency_report: ../../report/index.html
+.. _hpx_dependency_report: ../report/index.html
 .. |hpx_single_html| replace:: |hpx| Single HTML documentation
-.. _hpx_single_html: ../../singlehtml/index.h
+.. _hpx_single_html: ../singlehtml/index.h
 .. |hpx_pdf| replace:: |hpx| PDF documentation
-.. _hpx_pdf: ../../pdf/HPX.pdf
+.. _hpx_pdf: ../pdf/HPX.pdf
 
 .. |hpxpi| replace:: HPXPI
 .. _hpxpi: https://github.com/STEllAR-GROUP/hpxpi/

docs/sphinx/api/public_api.rst

@@ -23,7 +23,7 @@ sub-namespaces will eventually be removed.
 ``hpx/algorithm.hpp``
 =====================
 
-The header :hpx-header:`libs/full/include,include/hpx/algorithm.hpp` corresponds to the
+The header :hpx-header:`libs/full/include/include,hpx/algorithm.hpp` corresponds to the
 C++ standard library header :cppreference-header:`algorithm`. See :ref:`parallel_algorithms` for
 more information about the parallel algorithms.
 
@@ -191,7 +191,7 @@ Functions
 ``hpx/any.hpp``
 ===============
 
-The header :hpx-header:`libs/core/include_local,include/hpx/any.hpp` corresponds to the C++
+The header :hpx-header:`libs/core/include_local/include,hpx/any.hpp` corresponds to the C++
 standard library header :cppreference-header:`any`.
 
 :cpp:type:`hpx::any` is compatible with ``std::any``.
@@ -253,7 +253,7 @@ Macros
 ``hpx/barrier.hpp``
 ===================
 
-The header :hpx-header:`libs/full/include,include/hpx/barrier.hpp` corresponds to the
+The header :hpx-header:`libs/full/include/include,hpx/barrier.hpp` corresponds to the
 C++ standard library header :cppreference-header:`barrier` and contains a distributed barrier implementation. This
 functionality is also exposed through the ``hpx::distributed`` namespace. The name in
 ``hpx::distributed`` should be preferred.
@@ -282,7 +282,7 @@ Classes
 ``hpx/channel.hpp``
 ===================
 
-The header :hpx-header:`libs/full/include,include/hpx/channel.hpp` contains a local and a
+The header :hpx-header:`libs/full/include/include,hpx/channel.hpp` contains a local and a
 distributed channel implementation. This  functionality is also exposed through the ``hpx::distributed``
 namespace. The name in ``hpx::distributed`` should be preferred.
 
@@ -310,7 +310,7 @@ Classes
 ``hpx/chrono.hpp``
 ==================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/chrono.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/chrono.hpp` corresponds to the
 C++ standard library header :cppreference-header:`chrono`. The following replacements and
 extensions are provided compared to :cppreference-header:`chrono`.
 
@@ -332,7 +332,7 @@ Classes
 ``hpx/condition_variable.hpp``
 ==============================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/condition_variable.hpp` corresponds to the C++
+The header :hpx-header:`libs/core/include_local/include,hpx/condition_variable.hpp` corresponds to the C++
 standard library header :cppreference-header:`condition_variable`.
 
 Classes
@@ -353,7 +353,7 @@ Classes
 ``hpx/exception.hpp``
 =====================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/exception.hpp` corresponds to
+The header :hpx-header:`libs/core/include_local/include,hpx/exception.hpp` corresponds to
 the C++ standard library header :cppreference-header:`exception`. :cpp:class:`hpx::exception`
 extends ``std::exception`` and is the base class for all exceptions thrown in |hpx|.
 :c:macro:`HPX_THROW_EXCEPTION` can be used to throw |hpx| exceptions with file and line information
@@ -380,7 +380,7 @@ Classes
 ``hpx/execution.hpp``
 =====================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/execution.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/execution.hpp` corresponds to the
 C++ standard library header :cppreference-header:`execution`. See :ref:`parallel`,
 :ref:`parallel_algorithms` and :ref:`executor_parameters` for more information about execution
 policies and executor parameters.
@@ -430,7 +430,7 @@ Classes
 ``hpx/functional.hpp``
 ======================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/functional.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/functional.hpp` corresponds to the
 C++ standard library header :cppreference-header:`functional`. :cpp:class:`hpx::function` is a more
 efficient and serializable replacement for ``std::function``.
 
@@ -493,7 +493,7 @@ Functions
 ``hpx/future.hpp``
 ==================
 
-The header :hpx-header:`libs/full/include,include/hpx/future.hpp` corresponds to the
+The header :hpx-header:`libs/full/include/include,hpx/future.hpp` corresponds to the
 C++ standard library header :cppreference-header:`future`. See :ref:`extend_futures` for more
 information about extensions to futures compared to the C++ standard library.
 
@@ -610,7 +610,7 @@ Functions
 ``hpx/latch.hpp``
 =================
 
-The header :hpx-header:`libs/full/include,include/hpx/latch.hpp` corresponds to the C++
+The header :hpx-header:`libs/full/include/include,hpx/latch.hpp` corresponds to the C++
 standard library header :cppreference-header:`latch`. It contains a local and a distributed latch
 implementation. This functionality is also exposed through the ``hpx::distributed`` namespace.
 The name in ``hpx::distributed`` should be preferred.
@@ -639,7 +639,7 @@ Classes
 ``hpx/mutex.hpp``
 =================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/mutex.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/mutex.hpp` corresponds to the
 C++ standard library header :cppreference-header:`mutex`.
 
 Classes
@@ -675,7 +675,7 @@ Functions
 ``hpx/memory.hpp``
 ==================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/memory.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/memory.hpp` corresponds to the
 C++ standard library header :cppreference-header:`memory`. It contains parallel versions of the
 copy, fill, move, and construct helper functions in :cppreference-header:`memory`. See
 :ref:`parallel_algorithms` for more information about the parallel algorithms.
@@ -722,7 +722,7 @@ Functions
 ``hpx/numeric.hpp``
 ===================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/numeric.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/numeric.hpp` corresponds to the
 C++ standard library header :cppreference-header:`numeric`. See :ref:`parallel_algorithms` for more
 information about the parallel algorithms.
 
@@ -762,7 +762,7 @@ Functions
 ``hpx/optional.hpp``
 ====================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/optional.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/optional.hpp` corresponds to the
 C++ standard library header :cppreference-header:`optional`. :cpp:type:`hpx::optional` is compatible
 with ``std::optional``.
 
@@ -789,7 +789,7 @@ Classes
 ``hpx/runtime.hpp``
 ===================
 
-The header :hpx-header:`libs/full/include,include/hpx/runtime.hpp` contains functions for accessing
+The header :hpx-header:`libs/full/include/include,hpx/runtime.hpp` contains functions for accessing
 local and distributed runtime information.
 
 Typedefs
@@ -849,7 +849,7 @@ Functions
 ``hpx/source_location.hpp``
 ===========================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/source_location.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/source_location.hpp` corresponds to the
 C++ standard library header :cppreference-header:`source_location`.
 
 Classes
@@ -868,7 +868,7 @@ Classes
 ``hpx/system_error.hpp``
 ========================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/system_error.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/system_error.hpp` corresponds to the
 C++ standard library header :cppreference-header:`system_error`.
 
 Classes
@@ -887,7 +887,7 @@ Classes
 ``hpx/task_block.hpp``
 ======================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/task_block.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/task_block.hpp` corresponds to the
 ``task_block`` feature in |cpp17_n4755|_. See :ref:`using_task_block` for more details on using task
 blocks.
 
@@ -922,7 +922,7 @@ Functions
 ``hpx/experimental/task_group.hpp``
 ===================================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/experimental/task_group.hpp`
+The header :hpx-header:`libs/core/include_local/include,hpx/experimental/task_group.hpp`
 corresponds to the ``task_group`` feature in |oneTBB|_.
 
 Classes
@@ -941,7 +941,7 @@ Classes
 ``hpx/thread.hpp``
 ==================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/thread.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/thread.hpp` corresponds to the
 C++ standard library header :cppreference-header:`thread`. The functionality in this header is
 equivalent to the standard library thread functionality, with the exception that the |hpx|
 equivalents are implemented on top of lightweight threads and the |hpx| runtime.
@@ -977,7 +977,7 @@ Functions
 ``hpx/semaphore.hpp``
 =====================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/semaphore.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/semaphore.hpp` corresponds to the
 C++ standard library header :cppreference-header:`semaphore`.
 
 Classes
@@ -997,7 +997,7 @@ Classes
 ``hpx/shared_mutex.hpp``
 ========================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/shared_mutex.hpp` corresponds to the
+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
@@ -1016,7 +1016,7 @@ Classes
 ``hpx/stop_token.hpp``
 ======================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/stop_token.hpp` corresponds to the
+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
@@ -1049,7 +1049,7 @@ Classes
 ``hpx/tuple.hpp``
 =================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/tuple.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/tuple.hpp` corresponds to the
 C++ standard library header :cppreference-header:`tuple`. :cpp:class:`hpx::tuple` can be used in
 CUDA device code, unlike ``std::tuple``.
 
@@ -1097,7 +1097,7 @@ Functions
 ``hpx/type_traits.hpp``
 =======================
 
-The header :hpx-header:`libs/core/include_local,include/hpx/type_traits.hpp` corresponds to the
+The header :hpx-header:`libs/core/include_local/include,hpx/type_traits.hpp` corresponds to the
 C++ standard library header :cppreference-header:`type_traits`.
 
 Classes
@@ -1117,7 +1117,7 @@ Classes
 ``hpx/unwrap.hpp``
 ==================
 
-The header :hpx-header:`libs/fcore/include_local,include/hpx/unwrap.hpp` contains utilities for
+The header :hpx-header:`libs/fcore/include_local/include,hpx/unwrap.hpp` contains utilities for
 unwrapping futures.
 
 Classes