From 82d6bc28c3e0d3718691e7f332ace713849a1964 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Thu, 27 Apr 2023 18:28:16 -0400 Subject: [PATCH] docs(diagrams): add diagrams using graphviz (#1228) --- .readthedocs.yaml | 14 ++------------ docs/Doxyfile | 6 +++--- docs/source/source/src/audio.rst | 1 + docs/source/source/src/cbs.rst | 1 + docs/source/source/src/config.rst | 1 + docs/source/source/src/confighttp.rst | 1 + docs/source/source/src/crypto.rst | 1 + docs/source/source/src/httpcommon.rst | 1 + docs/source/source/src/input.rst | 1 + docs/source/source/src/main.rst | 1 + docs/source/source/src/move_by_copy.rst | 1 + docs/source/source/src/network.rst | 1 + docs/source/source/src/nvhttp.rst | 1 + docs/source/source/src/platform/linux/cuda.rst | 1 + docs/source/source/src/platform/linux/vaapi.rst | 1 + docs/source/source/src/platform/linux/wayland.rst | 1 + docs/source/source/src/platform/macos/misc.rst | 1 + docs/source/source/src/platform/windows/misc.rst | 1 + docs/source/source/src/process.rst | 1 + docs/source/source/src/round_robin.rst | 1 + docs/source/source/src/rtsp.rst | 1 + docs/source/source/src/stream.rst | 1 + docs/source/source/src/sync.rst | 1 + docs/source/source/src/system_tray.rst | 1 + docs/source/source/src/task_pool.rst | 1 + docs/source/source/src/thread_pool.rst | 1 + docs/source/source/src/thread_safe.rst | 1 + docs/source/source/src/upnp.rst | 1 + docs/source/source/src/uuid.rst | 1 + docs/source/source/src/video.rst | 1 + 30 files changed, 33 insertions(+), 15 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 75ec50a7..3316c40e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,18 +11,8 @@ build: os: ubuntu-20.04 tools: python: "3.10" - -## apt packages required packages to run cmake on sunshine, note that additional packages are required -# apt_packages: -# - cmake -# - libboost-filesystem-dev -# - libboost-log-dev -# - libboost-thread-dev - -## run cmake -# jobs: -# pre_build: -# - cmake . + apt_packages: + - graphviz ## Include the submodules, required for cmake # submodules: diff --git a/docs/Doxyfile b/docs/Doxyfile index 9fe84048..728c246f 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -184,7 +184,7 @@ FULL_PATH_NAMES = YES # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = +STRIP_FROM_PATH = ../ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which @@ -193,7 +193,7 @@ STRIP_FROM_PATH = # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = ../ # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't @@ -2463,7 +2463,7 @@ HIDE_UNDOC_RELATIONS = YES # set to NO # The default value is: NO. -HAVE_DOT = NO +HAVE_DOT = YES # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed # to run in parallel. When set to 0 doxygen will base this on the number of diff --git a/docs/source/source/src/audio.rst b/docs/source/source/src/audio.rst index a8fb3c9c..08665fe6 100644 --- a/docs/source/source/src/audio.rst +++ b/docs/source/source/src/audio.rst @@ -2,3 +2,4 @@ audio ===== .. doxygenfile:: audio.h + :allow-dot-graphs: diff --git a/docs/source/source/src/cbs.rst b/docs/source/source/src/cbs.rst index 2abe9915..6547c495 100644 --- a/docs/source/source/src/cbs.rst +++ b/docs/source/source/src/cbs.rst @@ -2,3 +2,4 @@ cbs === .. doxygenfile:: cbs.h + :allow-dot-graphs: diff --git a/docs/source/source/src/config.rst b/docs/source/source/src/config.rst index 44e10565..34bccff3 100644 --- a/docs/source/source/src/config.rst +++ b/docs/source/source/src/config.rst @@ -2,3 +2,4 @@ config ====== .. doxygenfile:: config.h + :allow-dot-graphs: diff --git a/docs/source/source/src/confighttp.rst b/docs/source/source/src/confighttp.rst index 3b46ba5e..348f6521 100644 --- a/docs/source/source/src/confighttp.rst +++ b/docs/source/source/src/confighttp.rst @@ -2,3 +2,4 @@ confighttp ========== .. doxygenfile:: confighttp.h + :allow-dot-graphs: diff --git a/docs/source/source/src/crypto.rst b/docs/source/source/src/crypto.rst index 5abf2469..aced9d35 100644 --- a/docs/source/source/src/crypto.rst +++ b/docs/source/source/src/crypto.rst @@ -2,3 +2,4 @@ crypto ====== .. doxygenfile:: crypto.h + :allow-dot-graphs: diff --git a/docs/source/source/src/httpcommon.rst b/docs/source/source/src/httpcommon.rst index 8afbdeb2..67557f86 100644 --- a/docs/source/source/src/httpcommon.rst +++ b/docs/source/source/src/httpcommon.rst @@ -2,3 +2,4 @@ httpcommon ========== .. doxygenfile:: httpcommon.h + :allow-dot-graphs: diff --git a/docs/source/source/src/input.rst b/docs/source/source/src/input.rst index e1988b24..4c8db082 100644 --- a/docs/source/source/src/input.rst +++ b/docs/source/source/src/input.rst @@ -2,3 +2,4 @@ input ===== .. doxygenfile:: input.h + :allow-dot-graphs: diff --git a/docs/source/source/src/main.rst b/docs/source/source/src/main.rst index cd6716fa..5102a3e9 100644 --- a/docs/source/source/src/main.rst +++ b/docs/source/source/src/main.rst @@ -2,3 +2,4 @@ main ==== .. doxygenfile:: main.h + :allow-dot-graphs: diff --git a/docs/source/source/src/move_by_copy.rst b/docs/source/source/src/move_by_copy.rst index 034c3aa2..5ec37716 100644 --- a/docs/source/source/src/move_by_copy.rst +++ b/docs/source/source/src/move_by_copy.rst @@ -2,3 +2,4 @@ move_by_copy ============ .. doxygenfile:: move_by_copy.h + :allow-dot-graphs: diff --git a/docs/source/source/src/network.rst b/docs/source/source/src/network.rst index 00df0e16..a9121e16 100644 --- a/docs/source/source/src/network.rst +++ b/docs/source/source/src/network.rst @@ -2,3 +2,4 @@ network ======= .. doxygenfile:: network.h + :allow-dot-graphs: diff --git a/docs/source/source/src/nvhttp.rst b/docs/source/source/src/nvhttp.rst index ea4daa01..8a3bbd00 100644 --- a/docs/source/source/src/nvhttp.rst +++ b/docs/source/source/src/nvhttp.rst @@ -2,3 +2,4 @@ nvhttp ====== .. doxygenfile:: nvhttp.h + :allow-dot-graphs: diff --git a/docs/source/source/src/platform/linux/cuda.rst b/docs/source/source/src/platform/linux/cuda.rst index cb975aa9..5b6dffe7 100644 --- a/docs/source/source/src/platform/linux/cuda.rst +++ b/docs/source/source/src/platform/linux/cuda.rst @@ -2,3 +2,4 @@ cuda ==== .. doxygenfile:: platform/linux/cuda.h + :allow-dot-graphs: diff --git a/docs/source/source/src/platform/linux/vaapi.rst b/docs/source/source/src/platform/linux/vaapi.rst index 8880e079..973e7852 100644 --- a/docs/source/source/src/platform/linux/vaapi.rst +++ b/docs/source/source/src/platform/linux/vaapi.rst @@ -2,3 +2,4 @@ vaapi ===== .. doxygenfile:: platform/linux/vaapi.h + :allow-dot-graphs: diff --git a/docs/source/source/src/platform/linux/wayland.rst b/docs/source/source/src/platform/linux/wayland.rst index 72f74fe2..670e4340 100644 --- a/docs/source/source/src/platform/linux/wayland.rst +++ b/docs/source/source/src/platform/linux/wayland.rst @@ -2,3 +2,4 @@ wayland ======= .. doxygenfile:: platform/linux/wayland.h + :allow-dot-graphs: diff --git a/docs/source/source/src/platform/macos/misc.rst b/docs/source/source/src/platform/macos/misc.rst index f000da08..26cbc187 100644 --- a/docs/source/source/src/platform/macos/misc.rst +++ b/docs/source/source/src/platform/macos/misc.rst @@ -2,3 +2,4 @@ misc ==== .. doxygenfile:: platform/macos/misc.h + :allow-dot-graphs: diff --git a/docs/source/source/src/platform/windows/misc.rst b/docs/source/source/src/platform/windows/misc.rst index cca4b82f..88c16200 100644 --- a/docs/source/source/src/platform/windows/misc.rst +++ b/docs/source/source/src/platform/windows/misc.rst @@ -2,3 +2,4 @@ misc ==== .. doxygenfile:: platform/windows/misc.h + :allow-dot-graphs: diff --git a/docs/source/source/src/process.rst b/docs/source/source/src/process.rst index fd4110a0..ad8f9764 100644 --- a/docs/source/source/src/process.rst +++ b/docs/source/source/src/process.rst @@ -2,3 +2,4 @@ process ======= .. doxygenfile:: process.h + :allow-dot-graphs: diff --git a/docs/source/source/src/round_robin.rst b/docs/source/source/src/round_robin.rst index 2a838b88..89aea6f5 100644 --- a/docs/source/source/src/round_robin.rst +++ b/docs/source/source/src/round_robin.rst @@ -2,3 +2,4 @@ round_robin =========== .. doxygenfile:: round_robin.h + :allow-dot-graphs: diff --git a/docs/source/source/src/rtsp.rst b/docs/source/source/src/rtsp.rst index 419f7d7f..7aee0baf 100644 --- a/docs/source/source/src/rtsp.rst +++ b/docs/source/source/src/rtsp.rst @@ -2,3 +2,4 @@ rtsp ==== .. doxygenfile:: rtsp.h + :allow-dot-graphs: diff --git a/docs/source/source/src/stream.rst b/docs/source/source/src/stream.rst index b9bcc4b4..c7714140 100644 --- a/docs/source/source/src/stream.rst +++ b/docs/source/source/src/stream.rst @@ -2,3 +2,4 @@ stream ====== .. doxygenfile:: stream.h + :allow-dot-graphs: diff --git a/docs/source/source/src/sync.rst b/docs/source/source/src/sync.rst index 43cea778..6f3d9592 100644 --- a/docs/source/source/src/sync.rst +++ b/docs/source/source/src/sync.rst @@ -2,3 +2,4 @@ sync ==== .. doxygenfile:: sync.h + :allow-dot-graphs: diff --git a/docs/source/source/src/system_tray.rst b/docs/source/source/src/system_tray.rst index 3b69c246..7c1009e1 100644 --- a/docs/source/source/src/system_tray.rst +++ b/docs/source/source/src/system_tray.rst @@ -2,3 +2,4 @@ system_tray =========== .. doxygenfile:: system_tray.h + :allow-dot-graphs: diff --git a/docs/source/source/src/task_pool.rst b/docs/source/source/src/task_pool.rst index 8c372314..cad02fa7 100644 --- a/docs/source/source/src/task_pool.rst +++ b/docs/source/source/src/task_pool.rst @@ -2,3 +2,4 @@ tasl_pool ========= .. doxygenfile:: task_pool.h + :allow-dot-graphs: diff --git a/docs/source/source/src/thread_pool.rst b/docs/source/source/src/thread_pool.rst index 3d563bd3..32787512 100644 --- a/docs/source/source/src/thread_pool.rst +++ b/docs/source/source/src/thread_pool.rst @@ -2,3 +2,4 @@ thread_pool =========== .. doxygenfile:: thread_pool.h + :allow-dot-graphs: diff --git a/docs/source/source/src/thread_safe.rst b/docs/source/source/src/thread_safe.rst index 00f394c4..d7ecdda3 100644 --- a/docs/source/source/src/thread_safe.rst +++ b/docs/source/source/src/thread_safe.rst @@ -2,3 +2,4 @@ thread_safe =========== .. doxygenfile:: thread_safe.h + :allow-dot-graphs: diff --git a/docs/source/source/src/upnp.rst b/docs/source/source/src/upnp.rst index b38e8d63..98769235 100644 --- a/docs/source/source/src/upnp.rst +++ b/docs/source/source/src/upnp.rst @@ -2,3 +2,4 @@ upnp ==== .. doxygenfile:: upnp.h + :allow-dot-graphs: diff --git a/docs/source/source/src/uuid.rst b/docs/source/source/src/uuid.rst index 803f0e1c..d21e0a6c 100644 --- a/docs/source/source/src/uuid.rst +++ b/docs/source/source/src/uuid.rst @@ -2,3 +2,4 @@ uuid ==== .. doxygenfile:: uuid.h + :allow-dot-graphs: diff --git a/docs/source/source/src/video.rst b/docs/source/source/src/video.rst index 17bca35e..2e45883f 100644 --- a/docs/source/source/src/video.rst +++ b/docs/source/source/src/video.rst @@ -2,3 +2,4 @@ video ===== .. doxygenfile:: video.h + :allow-dot-graphs: