diff --git a/docs/Makefile b/Makefile similarity index 93% rename from docs/Makefile rename to Makefile index 8fb8466..1e90cd8 100644 --- a/docs/Makefile +++ b/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 b/docs/_static/bootstrap-sphinx.css_t similarity index 100% rename from docs/source/_static/bootstrap-sphinx.css_t rename to docs/_static/bootstrap-sphinx.css_t diff --git a/docs/source/_templates/globaltoc.html b/docs/_templates/globaltoc.html similarity index 100% rename from docs/source/_templates/globaltoc.html rename to docs/_templates/globaltoc.html diff --git a/docs/source/_templates/layout.html b/docs/_templates/layout.html similarity index 100% rename from docs/source/_templates/layout.html rename to docs/_templates/layout.html diff --git a/docs/source/_templates/navbar.html b/docs/_templates/navbar.html similarity index 100% rename from docs/source/_templates/navbar.html rename to docs/_templates/navbar.html diff --git a/docs/source/address.rst b/docs/address.rst similarity index 100% rename from docs/source/address.rst rename to docs/address.rst diff --git a/docs/source/advanced.rst b/docs/advanced.rst similarity index 100% rename from docs/source/advanced.rst rename to docs/advanced.rst diff --git a/docs/source/bank_account.rst b/docs/bank_account.rst similarity index 100% rename from docs/source/bank_account.rst rename to docs/bank_account.rst diff --git a/docs/source/batch.rst b/docs/batch.rst similarity index 100% rename from docs/source/batch.rst rename to docs/batch.rst diff --git a/docs/source/conf.py b/docs/conf.py similarity index 100% rename from docs/source/conf.py rename to docs/conf.py diff --git a/docs/source/credit_card.rst b/docs/credit_card.rst similarity index 100% rename from docs/source/credit_card.rst rename to docs/credit_card.rst diff --git a/docs/source/customer.rst b/docs/customer.rst similarity index 100% rename from docs/source/customer.rst rename to docs/customer.rst diff --git a/docs/source/development.rst b/docs/development.rst similarity index 100% rename from docs/source/development.rst rename to docs/development.rst diff --git a/docs/source/getting_started.rst b/docs/getting_started.rst similarity index 100% rename from docs/source/getting_started.rst rename to docs/getting_started.rst diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/source/install.rst b/docs/install.rst similarity index 100% rename from docs/source/install.rst rename to docs/install.rst diff --git a/docs/source/recurring.rst b/docs/recurring.rst similarity index 100% rename from docs/source/recurring.rst rename to docs/recurring.rst diff --git a/docs/source/transaction.rst b/docs/transaction.rst similarity index 100% rename from docs/source/transaction.rst rename to docs/transaction.rst diff --git a/docs/make.bat b/make.bat similarity index 100% rename from docs/make.bat rename to make.bat