Merge pull request #7 from rsps/add-docs

Add static site generator for building documentation

Author: aedart

.gitignore

@@ -15,3 +15,5 @@ build/
 .build/
 
 .idea/
+
+/vendor

CHANGELOG.md

@@ -20,5 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * A "mini" testing framework for cmake modules and scripts, in `testing.cmake`. 
 * `RSP_CMAKE_SCRIPTS_BUILD_TESTS` project option for building tests.
 * `tests.yaml` GitHub Actions workflow.
+* `composer.json` to install [Daux.io](https://daux.io) dev-dependency (_documentation generator_).
+* "rsp" theme for Daux (_placed in `resources/daux/themes/rsp`_).
 
 [Unreleased]: https://github.com/rsps/cmake-scripts/compare/develop

composer.json

@@ -0,0 +1,43 @@
+{
+    "name": "rsp/cmake-scripts",
+    "description": "A collection of CMake scripts for C++ projects.",
+    "type": "library",
+    "license": "MIT",
+    "homepage": "https://github.com/rsps/cmake-scripts",
+    "support": {
+        "source": "https://github.com/rsps/cmake-scripts",
+        "issues": "https://github.com/rsps/cmake-scripts/issues"
+    },
+    "authors": [
+        {
+            "name": "Alin Eugen Deac",
+            "email": "[email protected]",
+            "role": "developer"
+        }
+    ],
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "php": "^8.2",
+        "daux/daux.io": "^0.22.3"
+    },
+    "scripts": {
+        "docs:build": [
+            "@make:docs-build-dir",
+            "vendor/bin/daux clear-cache",
+            "vendor/bin/daux generate --source=docs --destination=build/docs/"
+        ],
+        "docs:dev": [
+            "@make:docs-build-dir",
+            "vendor/bin/daux serve"
+        ],
+        "make:docs-build-dir": [
+            "@php -r \"is_dir('build/docs') || mkdir(directory: 'build/docs', recursive: true);\""
+        ]
+    },
+    "scripts-descriptions": {
+        "docs:build": "Builds a Html page containing all documentation, in the 'build/docs' directory",
+        "docs:dev": "Live update the documentation",
+        "make:docs-build-dir": "Creates the build directory for the documentation, if it does not already exist"
+    }
+}