Skip to content

Added standard doc Makefile, updated .gitignore #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
henkmuller wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added standard doc Makefile, updated .gitignore #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c882f2
Added build directories in doc to standard .gitignore
henkmuller Oct 31, 2011
6ca5982
Added default Makefile for documentation
henkmuller Oct 31, 2011
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
6 changes: 5 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*/.build_*/*
*/.build*/*
*/bin/*
*.o
*.xe
Expand All @@ -7,3 +7,7 @@
*.xi
*.i
*.a
doc/.doxygen/
doc/.sources/
doc/Doxyfile-e
doc/_build/
28 changes: 28 additions & 0 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Change this line to reflect your repo name
#
REPO=../../xcore_template

#
# Change this line to title your repo documentation
#
SPHINX_PROJECT_NAME=XCore Template

#
# Set the version number to something appropriate, eg
# VERSION=0v1
#
VERSION=0v1

#
# Add all module names here eg
# DOXYGEN_DIRS=$(REPO)/module_bob $(REPO)/module_john
#
DOXYGEN_DIRS=

#========== Nothing needs changing beyond this point
SOURCE_INCLUDE_DIRS=$(REPO)
XDOC_DIR ?= ../../xdoc
include $(XDOC_DIR)/Makefile.inc

all: html pdf
@if [ ! -d $(REPO)_gh_pages ] ; then echo '**** no gh_pages checked out ****'; exit 0; else cp -r _build/html/* $(REPO)_gh_pages/; cp -r _build/html/.doctrees $(REPO)_gh_pages/; echo 'HTML files copied to $(REPO)_gh_pages'; echo 'Now go to $(REPO)_gh_pages, add, commit, and push to publish the documentation'; fi