scripts: github pages publishing

Author: Sarcasm

.gitignore

@@ -1 +1,2 @@
 /.build/
+/_pages/

Makefile

@@ -6,10 +6,11 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = .build
+PUBLISHDIR    = _pages
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you do not have Sphinx installed, grab it from http://sphinx-doc.org/)
 endif
 
 # Internal variables.
@@ -23,6 +24,7 @@ I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
 help:
 	@echo "Please use \`make <target>' where <target> is one of"
+	@printf "  %-10s to make standalone HTML files in $(PUBLISHDIR)/ directory\n" $(PUBLISHDIR)
 	@echo "  html       to make standalone HTML files"
 	@echo "  dirhtml    to make HTML files named index.html in directories"
 	@echo "  singlehtml to make a single large HTML file"
@@ -48,9 +50,22 @@ help:
 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 	@echo "  coverage   to run coverage check of the documentation (if enabled)"
 
-clean:
+clean: clean-$(PUBLISHDIR)
 	rm -rf $(BUILDDIR)/*
 
+.PHONY: clean-$(PUBLISHDIR)
+clean-$(PUBLISHDIR):
+	rm -rf $(PUBLISHDIR)/* $(PUBLISHDIR)/.buildinfo
+
+.PHONY: $(PUBLISHDIR)
+$(PUBLISHDIR): clean-$(PUBLISHDIR)
+	@test -d $(PUBLISHDIR) || \
+		{ 2>&1 echo "error: directory missing $(PUBLISHDIR)/"; exit 1; }
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(PUBLISHDIR)
+	@rm $(PUBLISHDIR)/.buildinfo
+	@echo
+	@echo "Build finished. The HTML pages are in $(PUBLISHDIR)/."
+
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo

README.md

@@ -0,0 +1,28 @@
+# Notes
+
+These are some notes I want to keep around.
+
+# Setup
+
+```
+git clone [email protected]:Sarcasm/notes.git
+cd notes
+git fetch origin gh-pages
+git checkout gh-pages
+git checkout master
+git worktree add --checkout _pages gh-pages
+# configure `git push` to push both branches
+git config remote.origin.push refs/heads/master:refs/heads/master
+git config --add remote.origin.push refs/heads/gh-pages:refs/heads/gh-pages
+```
+
+# Publish changes
+
+After a change has been committed to the main branch, it's possible to publish
+using this procedure:
+
+```
+make _pages
+./commit-pages.sh
+git push
+```

commit-pages.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -o errexit
+
+commit_msg=$(git log -1 --pretty=tformat:"publish %h: %s")
+cd _pages
+git add .
+git commit -m "$commit_msg"

conf.py

@@ -5,15 +5,11 @@
 # containing dir.
 #
 
-import sys
-import os
-import shlex
-
 # -- General configuration ------------------------------------------------
 
 # General information about the project.
 project = 'Sarcasm tips'
-copyright = '2015, Guillaume Papin'
+copyright = '2016, Guillaume Papin'
 author = 'Guillaume Papin'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -66,7 +62,7 @@
 nitpicky = True
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = [] # '.templates'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
@@ -125,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['.static']
+html_static_path = [] # '.static'
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied