docs: use doxygen-awesome-css (#2758)

This commit is contained in:
ReenigneArcher 2024-06-26 10:44:32 -04:00 committed by GitHub
commit 7e9a2dd621
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 166 additions and 9 deletions

View file

@ -128,9 +128,12 @@ todo_include_todos = True
# https://github.com/readthedocs/readthedocs.org/blob/eadf6ac6dc6abc760a91e1cb147cc3c5f37d1ea8/docs/conf.py#L235-L236
suppress_warnings = ["epub.unknown_project_files"]
doxygen_cmd = os.getenv('DOXY_PATH', 'doxygen')
print(f'doxygen command: {doxygen_cmd}')
# get doxygen version
doxy_version = _run_subprocess(
args_list=['doxygen', '--version'],
args_list=[doxygen_cmd, '--version'],
cwd=source_dir,
)
@ -147,7 +150,7 @@ for d in directories:
# run doxygen
doxy_proc = _run_subprocess(
args_list=['doxygen', 'Doxyfile'],
args_list=[doxygen_cmd, 'Doxyfile'],
cwd=source_dir
)

View file

@ -13,6 +13,10 @@ Test clang-format locally.
Sphinx
------
.. note:: Documentation is now a cmake target and this is all handled by the cmake build system. When compiling docs
as a target, simply install Python, Doxygen, and Graphviz. The installation of python dependencies will be handled
automatically inside a virtual environment. The following instructions are for manual building of the docs.
Sunshine uses `Sphinx <https://www.sphinx-doc.org/en/master/>`__ for documentation building. Sphinx, along with other
required python dependencies are included in the `./docs/requirements.txt` file. Python is required to build
sphinx docs. Installation and setup of python will not be covered here.