From a6c3f4cf874d9311d1c02aa46c8daea1b8c1a9ae Mon Sep 17 00:00:00 2001 From: kamkow1 Date: Tue, 30 Dec 2025 17:04:05 +0100 Subject: [PATCH] Move kernel doxygen stuff to kernel/ --- docs.mk | 11 +++++------ docs/index.md | 2 +- Doxyfile => kernel/Doxyfile | 18 +++++++++--------- kernel/Makefile | 5 ++++- .../doxygen_layout.xml | 0 5 files changed, 19 insertions(+), 17 deletions(-) rename Doxyfile => kernel/Doxyfile (99%) rename doxygen_layout.xml => kernel/doxygen_layout.xml (100%) diff --git a/docs.mk b/docs.mk index 126285f..a9c0f4e 100644 --- a/docs.mk +++ b/docs.mk @@ -1,8 +1,7 @@ -docs: - doxygen +doxygen_kernel: + make -C kernel platform=$(platform) doxygen + +docs: doxygen_kernel mkdocs build -doxygen: - doxygen - -.PHONY: docs doxygen +.PHONY: docs doxygen_kernel diff --git a/docs/index.md b/docs/index.md index 4076a24..3bf1c1e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,4 +4,4 @@ MOP3 is a hobby OS project of mine ;). # Kernel documentation -- [Doxygen docs](doxygen/html/index.html) +- [Doxygen docs](kernel/doxygen/html/index.html) diff --git a/Doxyfile b/kernel/Doxyfile similarity index 99% rename from Doxyfile rename to kernel/Doxyfile index 8c95f17..a189059 100644 --- a/Doxyfile +++ b/kernel/Doxyfile @@ -74,7 +74,7 @@ PROJECT_ICON = # entered, it will be relative to the location where Doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = docs/doxygen +OUTPUT_DIRECTORY = ../docs/kernel/doxygen # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format @@ -1005,7 +1005,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = kernel +INPUT = . # This tag can be used to specify the character encoding of the source files # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses @@ -1109,12 +1109,12 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which Doxygen is # run. -EXCLUDE = kernel/uACPI \ - kernel/build \ - kernel/limine/limine.h \ - kernel/libk/printf.c \ - kernel/libk/printf.h \ - kernel/amd64/msr-index.h +EXCLUDE = uACPI \ + build \ + limine/limine.h \ + libk/printf.c \ + libk/printf.h \ + amd64/msr-index.h # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -1474,7 +1474,7 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = doxytheme/doxygen-awesome.css +HTML_EXTRA_STYLESHEET = ../doxytheme/doxygen-awesome.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note diff --git a/kernel/Makefile b/kernel/Makefile index 7feb35b..1f9bb13 100644 --- a/kernel/Makefile +++ b/kernel/Makefile @@ -32,4 +32,7 @@ format: ':!uACPI/tests/**' \ ':!libk/printf*') -.PHONY: all clean format +doxygen: + doxygen + +.PHONY: all clean format doxygen diff --git a/doxygen_layout.xml b/kernel/doxygen_layout.xml similarity index 100% rename from doxygen_layout.xml rename to kernel/doxygen_layout.xml