1
0
forked from mirrors/0ad

docs: Improve Doxygen Visuals and Build process

- Switched to CMake for configuring and building the doxygen Website.
 - Set the minimum requirements to CMake >=3.18.4 and Doxygen >=1.9.1.
 - Rewrite the LICENSE.txt and docs README.txt to markdown.
 - Add the folder which is used in the README to gitignore.
 - Add a custom style to the doxygen website based on the docs webpage.
 - Update CI to use the new Doxygen Build process.

Closes #7052
This commit is contained in:
Cayleb-Ordo
2024-09-27 00:10:40 +02:00
committed by Itms
parent 75da070076
commit 19aca9fe74
11 changed files with 210 additions and 142 deletions
@@ -36,7 +36,7 @@ pipeline {
stage("Engine docs") {
steps {
sh "cd docs/doxygen/ && doxygen config"
sh "cd docs/doxygen/ && cmake -S . -B build-docs && cmake --build build-docs"
}
}
@@ -59,7 +59,7 @@ pipeline {
steps {
sshPublisher alwaysPublishFromMaster: true, failOnError: true, publishers: [
sshPublisherDesc(configName: 'docs.wildfiregames.com', transfers: [
sshTransfer(sourceFiles: 'docs/doxygen/html/**', removePrefix: 'docs/doxygen/html', remoteDirectory: 'pyrogenesis'),
sshTransfer(sourceFiles: 'docs/doxygen/output/html/**', removePrefix: 'docs/doxygen/output/html/', remoteDirectory: 'pyrogenesis'),
sshTransfer(sourceFiles: 'source/tools/entdocs/nightly.html', removePrefix: 'source/tools/entdocs', remoteDirectory: 'entity-docs'),
sshTransfer(sourceFiles: 'source/tools/templatesanalyzer/index.html', removePrefix: 'source/tools/templatesanalyzer', remoteDirectory: 'templatesanalyzer'),
]