docs(diagrams): add diagrams using graphviz (#1228)

.readthedocs.yaml

@@ -11,18 +11,8 @@ build:
   os: ubuntu-20.04
   tools:
     python: "3.10"
-
+  apt_packages:
-## apt packages required packages to run cmake on sunshine, note that additional packages are required
+    - graphviz
-#  apt_packages:
-#    - cmake
-#    - libboost-filesystem-dev
-#    - libboost-log-dev
-#    - libboost-thread-dev
-
-## run cmake
-#  jobs:
-#    pre_build:
-#      - cmake .
 
 ## Include the submodules, required for cmake
 #  submodules:

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

docs/source/source/src/audio.rst

@@ -2,3 +2,4 @@ audio
 =====
 
 .. doxygenfile:: audio.h
+   :allow-dot-graphs:

docs/source/source/src/cbs.rst

@@ -2,3 +2,4 @@ cbs
 ===
 
 .. doxygenfile:: cbs.h
+   :allow-dot-graphs:

docs/source/source/src/config.rst

@@ -2,3 +2,4 @@ config
 ======
 
 .. doxygenfile:: config.h
+   :allow-dot-graphs:

docs/source/source/src/confighttp.rst

@@ -2,3 +2,4 @@ confighttp
 ==========
 
 .. doxygenfile:: confighttp.h
+   :allow-dot-graphs:

docs/source/source/src/crypto.rst

@@ -2,3 +2,4 @@ crypto
 ======
 
 .. doxygenfile:: crypto.h
+   :allow-dot-graphs:

docs/source/source/src/httpcommon.rst

@@ -2,3 +2,4 @@ httpcommon
 ==========
 
 .. doxygenfile:: httpcommon.h
+   :allow-dot-graphs:

docs/source/source/src/input.rst

@@ -2,3 +2,4 @@ input
 =====
 
 .. doxygenfile:: input.h
+   :allow-dot-graphs:

docs/source/source/src/main.rst

@@ -2,3 +2,4 @@ main
 ====
 
 .. doxygenfile:: main.h
+   :allow-dot-graphs:

docs/source/source/src/move_by_copy.rst

@@ -2,3 +2,4 @@ move_by_copy
 ============
 
 .. doxygenfile:: move_by_copy.h
+   :allow-dot-graphs:

docs/source/source/src/network.rst

@@ -2,3 +2,4 @@ network
 =======
 
 .. doxygenfile:: network.h
+   :allow-dot-graphs:

docs/source/source/src/nvhttp.rst

@@ -2,3 +2,4 @@ nvhttp
 ======
 
 .. doxygenfile:: nvhttp.h
+   :allow-dot-graphs:

docs/source/source/src/platform/linux/cuda.rst

@@ -2,3 +2,4 @@ cuda
 ====
 
 .. doxygenfile:: platform/linux/cuda.h
+   :allow-dot-graphs:

docs/source/source/src/platform/linux/vaapi.rst

@@ -2,3 +2,4 @@ vaapi
 =====
 
 .. doxygenfile:: platform/linux/vaapi.h
+   :allow-dot-graphs:

docs/source/source/src/platform/linux/wayland.rst

@@ -2,3 +2,4 @@ wayland
 =======
 
 .. doxygenfile:: platform/linux/wayland.h
+   :allow-dot-graphs:

docs/source/source/src/platform/macos/misc.rst

@@ -2,3 +2,4 @@ misc
 ====
 
 .. doxygenfile:: platform/macos/misc.h
+   :allow-dot-graphs:

docs/source/source/src/platform/windows/misc.rst

@@ -2,3 +2,4 @@ misc
 ====
 
 .. doxygenfile:: platform/windows/misc.h
+   :allow-dot-graphs:

docs/source/source/src/process.rst

@@ -2,3 +2,4 @@ process
 =======
 
 .. doxygenfile:: process.h
+   :allow-dot-graphs:

docs/source/source/src/round_robin.rst

@@ -2,3 +2,4 @@ round_robin
 ===========
 
 .. doxygenfile:: round_robin.h
+   :allow-dot-graphs:

docs/source/source/src/rtsp.rst

@@ -2,3 +2,4 @@ rtsp
 ====
 
 .. doxygenfile:: rtsp.h
+   :allow-dot-graphs:

docs/source/source/src/stream.rst

@@ -2,3 +2,4 @@ stream
 ======
 
 .. doxygenfile:: stream.h
+   :allow-dot-graphs:

docs/source/source/src/sync.rst

@@ -2,3 +2,4 @@ sync
 ====
 
 .. doxygenfile:: sync.h
+   :allow-dot-graphs:

docs/source/source/src/system_tray.rst

@@ -2,3 +2,4 @@ system_tray
 ===========
 
 .. doxygenfile:: system_tray.h
+   :allow-dot-graphs:

docs/source/source/src/task_pool.rst

@@ -2,3 +2,4 @@ tasl_pool
 =========
 
 .. doxygenfile:: task_pool.h
+   :allow-dot-graphs:

docs/source/source/src/thread_pool.rst

@@ -2,3 +2,4 @@ thread_pool
 ===========
 
 .. doxygenfile:: thread_pool.h
+   :allow-dot-graphs:

docs/source/source/src/thread_safe.rst

@@ -2,3 +2,4 @@ thread_safe
 ===========
 
 .. doxygenfile:: thread_safe.h
+   :allow-dot-graphs:

docs/source/source/src/upnp.rst

@@ -2,3 +2,4 @@ upnp
 ====
 
 .. doxygenfile:: upnp.h
+   :allow-dot-graphs:

docs/source/source/src/uuid.rst

@@ -2,3 +2,4 @@ uuid
 ====
 
 .. doxygenfile:: uuid.h
+   :allow-dot-graphs:

docs/source/source/src/video.rst

@@ -2,3 +2,4 @@ video
 =====
 
 .. doxygenfile:: video.h
+   :allow-dot-graphs: