From 8ec21aac535841f2dae2daf57b78d0bed8961436 Mon Sep 17 00:00:00 2001 From: Ralph Sennhauser Date: Fri, 16 May 2025 14:36:33 +0200 Subject: [PATCH] Group documentation pages All documentation pages are made subpages of a page Documentation, this helps browse documentation not directly tied to source code. Signed-off-by: Ralph Sennhauser --- docs/doxygen/CMakeLists.txt | 3 +-- docs/doxygen/Main-Page.md | 14 -------------- docs/doxygen/mainpage.dox | 29 +++++++++++++++++++++++++++++ 3 files changed, 30 insertions(+), 16 deletions(-) delete mode 100644 docs/doxygen/Main-Page.md create mode 100644 docs/doxygen/mainpage.dox diff --git a/docs/doxygen/CMakeLists.txt b/docs/doxygen/CMakeLists.txt index 09ac91c5b3..21a4c2585b 100644 --- a/docs/doxygen/CMakeLists.txt +++ b/docs/doxygen/CMakeLists.txt @@ -34,7 +34,6 @@ if(DOXYGEN_FOUND) endif() set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/pyrogenesis.png) set(DOXYGEN_TAB_SIZE 4) - set(DOXYGEN_USE_MDFILE_AS_MAINPAGE ${CMAKE_CURRENT_SOURCE_DIR}/Main-Page.md) set(DOXYGEN_EXCLUDE_PATTERNS */.svn* */tests/test_*) set(DOXYGEN_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../source) set(DOXYGEN_EXAMPLE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../source) @@ -57,7 +56,7 @@ if(DOXYGEN_FOUND) doxygen_add_docs(${CMAKE_PROJECT_NAME} ${CMAKE_CURRENT_SOURCE_DIR}/../../source - ${CMAKE_CURRENT_SOURCE_DIR}/Main-Page.md + ${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox ${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE.md ALL) else() diff --git a/docs/doxygen/Main-Page.md b/docs/doxygen/Main-Page.md deleted file mode 100644 index b9c790a331..0000000000 --- a/docs/doxygen/Main-Page.md +++ /dev/null @@ -1,14 +0,0 @@ -# Pyrogenesis - -The Pyrogenesis Engine is specifically designed for flexibility and ease of modification. -This document should help all that want to contribute their Work to this Engine. - -## Thirdparty - -- [Vulkan Memory Allocator](https://gpuopen-librariesandsdks.github.io/VulkanMemoryAllocator/html/) -- [tinygettext](https://github.com/tinygettext/tinygettext) -- [doxygen-awesome-css](https://github.com/jothepro/doxygen-awesome-css) - -## License - -[0 A.D. Licensing Details](../../LICENSE.md) diff --git a/docs/doxygen/mainpage.dox b/docs/doxygen/mainpage.dox new file mode 100644 index 0000000000..68d133d7d5 --- /dev/null +++ b/docs/doxygen/mainpage.dox @@ -0,0 +1,29 @@ +/*! +@mainpage + +

Pyrogenesis

+ +

The Pyrogenesis Engine is specifically designed for flexibility and ease of modification.

+

This document should help all that want to contribute their Work to this Engine.

+ +

Thirdparty

+- Vulkan Memory Allocator +- tinygettext +- doxygen-awesome-css + +

License

+ +@link ../../LICENSE.md 0 A.D. Licensing Details + +*/ + + +/*! +@page docs Documentation + +

Components

+ +- @subpage writing-components +- @subpage serialization + +*/