Skip to content

Commit 9903b9e

Browse files
committed
ADDED: Support for doxygen documentation in gh-pages branch
1 parent eb0419d commit 9903b9e

File tree

5 files changed

+40
-9
lines changed

5 files changed

+40
-9
lines changed

CMakeLists.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ cmake_minimum_required (VERSION 2.6)
55
# Define Our Project
66
# ==================
77

8-
set (My_Project_Title "Some Project")
9-
set (My_Project_Description "A project built using the c-template system.")
8+
set (My_Project_Title "C-Template")
9+
set (My_Project_Description "Boilerplate c project with cmake support, CuTest unit testing, and more.")
1010
set (My_Project_Author "Fletcher T. Penney")
11-
set (My_Project_Revised_Date "2016-05-06")
11+
set (My_Project_Revised_Date "2016-08-24")
1212
set (My_Project_Version_Major 1)
1313
set (My_Project_Version_Minor 0)
14-
set (My_Project_Version_Patch 2)
14+
set (My_Project_Version_Patch 3)
1515

1616
set (My_Project_Version "${My_Project_Version_Major}.${My_Project_Version_Minor}.${My_Project_Version_Patch}")
1717

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,10 @@ documentation: $(BUILD_DIR)
6767
cmake -DDOCUMENTATION=1 ..; cd ..; \
6868
doxygen build/doxygen.conf
6969

70+
.PHONY : gh-pages
71+
gh-pages: documentation
72+
cp -r $(BUILD_DIR)/documentation/html/* documentation/
73+
7074
# Clean out the build directory
7175
.PHONY : clean
7276
clean:

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
| | |
44
| ---------- | ------------------------- |
5-
| Title: | Some Project |
6-
| Author: | Somebody |
7-
| Date: | 2015-06-05 |
8-
| Copyright: | Copyright © 2015 Somebody. |
9-
| Version: | 1.0.1 |
5+
| Title: | C-Template |
6+
| Author: | Fletcher T. Penney |
7+
| Date: | 2016-08-24 |
8+
| Copyright: | Copyright © 2015-2016 Fletcher T. Penney. |
9+
| Version: | 1.0.3 |
1010

1111

1212
## Introduction ##
@@ -148,6 +148,14 @@ Properly configuring your source for this is up to you. You can modify the
148148
of the basics are handled for you based on your CMake configuration.
149149

150150

151+
### GitHub Pages Support ###
152+
153+
The `configure-gh-pages` script sets up a `documentation` directory that is
154+
linked to a `gh-pages` branch of the project. You can then run `make gh-pages`
155+
to update the documentation in this directory. Commit and push to your origin,
156+
and your projects gh-page is updated.
157+
158+
151159
### Makefile ###
152160

153161
The overall build process is controlled by the master `Makefile`. It provides

configure-gh-pages

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#!/bin/sh
2+
3+
mkdir documentation
4+
5+
cd documentation
6+
7+
git clone .. .
8+
9+
git checkout --orphan gh-pages
10+
11+
git rm -rf .

templates/README.md.in

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,14 @@ Properly configuring your source for this is up to you. You can modify the
148148
of the basics are handled for you based on your CMake configuration.
149149

150150

151+
### GitHub Pages Support ###
152+
153+
The `configure-gh-pages` script sets up a `documentation` directory that is
154+
linked to a `gh-pages` branch of the project. You can then run `make gh-pages`
155+
to update the documentation in this directory. Commit and push to your origin,
156+
and your projects gh-page is updated.
157+
158+
151159
### Makefile ###
152160

153161
The overall build process is controlled by the master `Makefile`. It provides

0 commit comments

Comments
 (0)