jyapayne/Sunshine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: improvements to source code documentation (#1236)

Browse source
This commit is contained in:
ReenigneArcher 2023-05-07 15:01:44 -04:00 • committed by GitHub
commit 979f7f4e60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
71 changed files with 1284 additions and 1430 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/source/conf.py
View file

@ -95,8 +95,16 @@ breathe_projects = dict(
)
todo_include_todos = True
subprocess.run('doxygen', shell=True, cwd=source_dir)
# disable epub mimetype warnings
# https://github.com/readthedocs/readthedocs.org/blob/eadf6ac6dc6abc760a91e1cb147cc3c5f37d1ea8/docs/conf.py#L235-L236
suppress_warnings = ["epub.unknown_project_files"]
# get doxygen version
doxy_proc = subprocess.run('doxygen --version', shell=True, cwd=source_dir, capture_output=True)
doxy_version = doxy_proc.stdout.decode('utf-8').strip()
print('doxygen version: ' + doxy_version)
# run doxygen
doxy_proc = subprocess.run('doxygen Doxyfile', shell=True, cwd=source_dir)
if doxy_proc.returncode != 0:
raise RuntimeError('doxygen failed with return code ' + str(doxy_proc.returncode))