Documentation structure changes for gh-pages

eschwab · Mar 31, 2014 · 40b0a6a · 40b0a6a
1 parent cc3849a
commit 40b0a6a
Show file tree

Hide file tree

Showing 19 changed files with 14 additions and 2 deletions.
diff --git a/docs/Makefile → Makefile b/docs/Makefile → Makefile
@@ -6,6 +6,7 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
+GH_PAGES_SOURCE = docs Makefile
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -15,9 +16,9 @@ endif
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs
 # the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) docs
 
 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
 
@@ -54,6 +55,17 @@ html:
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+gh-pages:
+	git checkout gh-pages
+	rm -rf $(GH_PAGES_SOURCE) _build _sources _static
+	git checkout master $(GH_PAGES_SOURCE)
+	git reset HEAD
+	make html
+	mv -fv _build/html/* ./
+	rm -rf $(GH_PAGES_SOURCE)
+	git add -A
+	git commit -m "Generated gh-pages for `git log master -1 --pretty=short --abbrev-commit`" && git push origin gh-pages ; git checkout master
+
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo

diff --git a/docs/source/_static/bootstrap-sphinx.css_t → docs/_static/bootstrap-sphinx.css_t b/docs/source/_static/bootstrap-sphinx.css_t → docs/_static/bootstrap-sphinx.css_t
diff --git a/docs/source/_templates/globaltoc.html → docs/_templates/globaltoc.html b/docs/source/_templates/globaltoc.html → docs/_templates/globaltoc.html
diff --git a/docs/source/_templates/layout.html → docs/_templates/layout.html b/docs/source/_templates/layout.html → docs/_templates/layout.html
diff --git a/docs/source/_templates/navbar.html → docs/_templates/navbar.html b/docs/source/_templates/navbar.html → docs/_templates/navbar.html
diff --git a/docs/source/address.rst → docs/address.rst b/docs/source/address.rst → docs/address.rst
diff --git a/docs/source/advanced.rst → docs/advanced.rst b/docs/source/advanced.rst → docs/advanced.rst
diff --git a/docs/source/bank_account.rst → docs/bank_account.rst b/docs/source/bank_account.rst → docs/bank_account.rst
diff --git a/docs/source/batch.rst → docs/batch.rst b/docs/source/batch.rst → docs/batch.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
diff --git a/docs/source/credit_card.rst → docs/credit_card.rst b/docs/source/credit_card.rst → docs/credit_card.rst
diff --git a/docs/source/customer.rst → docs/customer.rst b/docs/source/customer.rst → docs/customer.rst
diff --git a/docs/source/development.rst → docs/development.rst b/docs/source/development.rst → docs/development.rst
diff --git a/docs/source/getting_started.rst → docs/getting_started.rst b/docs/source/getting_started.rst → docs/getting_started.rst
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/source/install.rst → docs/install.rst b/docs/source/install.rst → docs/install.rst
diff --git a/docs/source/recurring.rst → docs/recurring.rst b/docs/source/recurring.rst → docs/recurring.rst
diff --git a/docs/source/transaction.rst → docs/transaction.rst b/docs/source/transaction.rst → docs/transaction.rst
diff --git a/docs/make.bat → make.bat b/docs/make.bat → make.bat