Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
5f0fd53
Ignore PHP vendor directory
aedart Jan 23, 2025
d498851
Add daux.io dependency
aedart Jan 23, 2025
9a11a72
Change release notes
aedart Jan 23, 2025
fc88718
Fix call to non-existing "make:build-dir"
aedart Jan 23, 2025
49c2674
Fix docs build dir command
aedart Jan 23, 2025
497b7f9
Add daux configuration
aedart Jan 23, 2025
999ec7c
Add landing page (incomplete)
aedart Jan 23, 2025
dfe1403
Add archive
aedart Jan 23, 2025
e311c5c
Add placeholder for version 0.x docs
aedart Jan 23, 2025
c242e37
Change title and description
aedart Jan 23, 2025
7187b19
Change meta description
aedart Jan 23, 2025
34a98ca
Add release notes for version 0.x (incomplete)
aedart Jan 23, 2025
1a8e28b
Replace release notes with "how to install" guide (incomplete)
aedart Jan 23, 2025
52ae975
Fox typo and change formatting of warning
aedart Jan 23, 2025
491b70b
Add root level docs (incomplete)
aedart Jan 23, 2025
b0c3e0e
Add index pages for the available modules (incomplete)
aedart Jan 23, 2025
023fb55
Add index page for modules directory
aedart Jan 23, 2025
3d2d80b
Change sentence
aedart Jan 23, 2025
94f7646
Add dummy content
aedart Jan 23, 2025
ae3cda5
Add dummy text
aedart Jan 23, 2025
89010ce
Add styles
aedart Jan 23, 2025
05334e4
Add placeholder for archive entries
aedart Jan 24, 2025
1ac9773
Ignore archive placeholder
aedart Jan 24, 2025
5c83767
Reverse the order of shown archive entries
aedart Jan 24, 2025
a0c7529
Cleanup
aedart Jan 24, 2025
d437907
Add "work in progress" alert
aedart Jan 24, 2025
47a4641
Add warning for when viewing archived documentation
aedart Jan 24, 2025
2efef5f
Add scaffold for a "next version" index
aedart Jan 24, 2025
e4aecf3
Add placeholder content for "next" version
aedart Jan 24, 2025
d876720
Add info alert for when viewing "next" version documentation
aedart Jan 24, 2025
ae4b079
Fix outdated version warning shown on archive index page
aedart Jan 24, 2025
e78c9d0
Improve sentence
aedart Jan 24, 2025
70db533
Cleanup
aedart Jan 24, 2025
4a34d86
Restyle the "dark mode" toggle button
aedart Jan 24, 2025
6457507
Adjust fill colour for "dark mode" toggle btn
aedart Jan 24, 2025
65ec8cc
Adjust dark mode colours
aedart Jan 24, 2025
7c2c971
Add favicon
aedart Jan 24, 2025
8e15311
Move into themes / rsp directory
aedart Jan 24, 2025
9bc1b98
Add custom "rsp" theme
aedart Jan 24, 2025
e43624f
Change release notes
aedart Jan 24, 2025
460f8fe
Fix dual scroll-bars shown, when docs are built
aedart Jan 24, 2025
66f028f
Add more dummy content
aedart Jan 24, 2025
281b7d0
Cleanup
aedart Jan 24, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ build/
.build/

.idea/

/vendor
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
43 changes: 43 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -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": "alin@rspsystems.com",
"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"
}
}
Loading
Loading