docs: use glob pattern to match source code docs (#1918)

This commit is contained in:
ReenigneArcher 2023-12-17 10:37:54 -05:00 committed by GitHub
parent 4c984cacb5
commit 068c3fa303
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
45 changed files with 36 additions and 73 deletions

View File

@ -1,10 +0,0 @@
platform
========
.. toctree::
:maxdepth: 1
platform/common
platform/linux
platform/macos
platform/windows

View File

@ -1,12 +0,0 @@
linux
=====
.. toctree::
:maxdepth: 1
linux/cuda
linux/graphics
linux/misc
linux/vaapi
linux/wayland
linux/x11grab

View File

@ -1,11 +0,0 @@
macos
=====
.. toctree::
:maxdepth: 1
macos/av_audio
macos/av_img_t
macos/av_video
macos/misc
macos/nv12_zero_device

View File

@ -1,9 +0,0 @@
windows
=======
.. toctree::
:maxdepth: 1
windows/display
windows/misc
windows/PolicyConfig

View File

@ -1,5 +1,5 @@
src
===
Source Code
===========
We are in process of improving the source code documentation. Code should be documented using Doxygen syntax.
Some examples exist in `main.h` and `main.cpp`. In order for documentation within the code to appear in the
rendered docs, the definition of the object must be in a header file, although the documentation itself can (and
@ -52,35 +52,40 @@ Example Documentation Blocks
// do stuff
}
Code
----
Source
------
.. toctree::
:maxdepth: 2
:caption: src
:maxdepth: 1
:glob:
src/main
src/audio
src/cbs
src/config
src/confighttp
src/crypto
src/httpcommon
src/input
src/move_by_copy
src/network
src/nvhttp
src/process
src/round_robin
src/rtsp
src/stream
src/sync
src/system_tray
src/task_pool
src/thread_pool
src/thread_safe
src/upnp
src/utility
src/uuid
src/video
src/platform
src/*
.. toctree::
:caption: src/platform
:maxdepth: 1
:glob:
src/platform/*
.. toctree::
:caption: src/platform/linux
:maxdepth: 1
:glob:
src/platform/linux/*
.. toctree::
:caption: src/platform/macos
:maxdepth: 1
:glob:
src/platform/macos/*
.. toctree::
:caption: src/platform/windows
:maxdepth: 1
:glob:
src/platform/windows/*

View File

@ -53,4 +53,4 @@
:maxdepth: 2
:caption: source
source/src
source_code/source_code