fletcher/MultiMarkdown-6
1
1
Fork 0
mirror of https://github.com/fletcher/MultiMarkdown-6.git synced 2024-10-04 18:47:31 +03:00
Code Issues Projects Releases Wiki Activity

ADDED: Support for doxygen documentation in gh-pages branch

Browse Source
This commit is contained in:
Fletcher T. Penney 2016-08-24 21:44:09 -04:00
parent eb0419d181
commit 9903b9ebb6
5 changed files with 40 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CMakeLists.txt
View File

@ -5,13 +5,13 @@ cmake_minimum_required (VERSION 2.6)
# Define Our Project
# ==================
set (My_Project_Title "Some Project")
set (My_Project_Description "A project built using the c-template system.")
set (My_Project_Title "C-Template")
set (My_Project_Description "Boilerplate c project with cmake support, CuTest unit testing, and more.")
set (My_Project_Author "Fletcher T. Penney")
set (My_Project_Revised_Date "2016-05-06")
set (My_Project_Revised_Date "2016-08-24")
set (My_Project_Version_Major 1)
set (My_Project_Version_Minor 0)
set (My_Project_Version_Patch 2)
set (My_Project_Version_Patch 3)
set (My_Project_Version "${My_Project_Version_Major}.${My_Project_Version_Minor}.${My_Project_Version_Patch}")

4
Makefile
View File

@ -67,6 +67,10 @@ documentation: $(BUILD_DIR)
cmake -DDOCUMENTATION=1 ..; cd ..; \
doxygen build/doxygen.conf
.PHONY : gh-pages
gh-pages: documentation
cp -r $(BUILD_DIR)/documentation/html/* documentation/
# Clean out the build directory
.PHONY : clean
clean:

18
README.md
View File

@ -2,11 +2,11 @@
| | |
| ---------- | ------------------------- |
| Title: | Some Project |
| Author: | Somebody |
| Date: | 2015-06-05 |
| Copyright: | Copyright © 2015 Somebody. |
| Version: | 1.0.1 |
| Title: | C-Template |
| Author: | Fletcher T. Penney |
| Date: | 2016-08-24 |
| Copyright: | Copyright © 2015-2016 Fletcher T. Penney. |
| Version: | 1.0.3 |
## Introduction ##
@ -148,6 +148,14 @@ Properly configuring your source for this is up to you. You can modify the
of the basics are handled for you based on your CMake configuration.
### GitHub Pages Support ###
The `configure-gh-pages` script sets up a `documentation` directory that is
linked to a `gh-pages` branch of the project. You can then run `make gh-pages`
to update the documentation in this directory. Commit and push to your origin,
and your projects gh-page is updated.
### Makefile ###
The overall build process is controlled by the master `Makefile`. It provides

11
configure-gh-pages Executable file
View File

@ -0,0 +1,11 @@
#!/bin/sh
mkdir documentation
cd documentation
git clone .. .
git checkout --orphan gh-pages
git rm -rf .

8
templates/README.md.in
View File

@ -148,6 +148,14 @@ Properly configuring your source for this is up to you. You can modify the
of the basics are handled for you based on your CMake configuration.
### GitHub Pages Support ###
The `configure-gh-pages` script sets up a `documentation` directory that is
linked to a `gh-pages` branch of the project. You can then run `make gh-pages`
to update the documentation in this directory. Commit and push to your origin,
and your projects gh-page is updated.
### Makefile ###
The overall build process is controlled by the master `Makefile`. It provides