update & org docsite Makefile

Author: TomDonoghue

doc/Makefile

@@ -1,4 +1,8 @@
 # Minimal makefile for Sphinx documentation
+#   This make is adapted & extended from the original sphinx file
+
+##########################################################################
+## Settings
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
@@ -7,6 +11,12 @@ SPHINXPROJ    = fooof
 SOURCEDIR     = .
 BUILDDIR      = _build
 
+# Custom settings
+GITHUBORG     = https://github.com/fooof-tools
+
+##########################################################################
+## Standard sphinx tasks (from sphinx)
+
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -18,6 +28,9 @@ help:
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
+##########################################################################
+## Custom tasks
+
 # Custom cleaner that also removes the generated files from sphinx-gallery
 clean:
 	rm -rf $(BUILDDIR)/*
@@ -35,24 +48,28 @@ check:
 plots:
 	python make_doc_plots.py
 
-# Build the html site, and push it to gh-pages branch of repo to deploy
-install:
-	# Clean out existing build
-	make clean
+# Deploy the site to github pages site
+deploy:
 	# Clone, specifically, the gh-pages branch, putting it into '_build/gh_pages/'
+	#   -b gh-pages --single-branch fetches specifically and only the gh-pages branch
 	#   --no-checkout just fetches the root folder without content
 	#   --depth 1 is a speed optimization since we don't need the history prior to the last commit
-	#   -b gh-pages fetches only the branch for the gh-pages
-	git clone -b gh-pages --single-branch --no-checkout --depth 1 https://github.com/fooof-tools/fooof _build/gh_pages
-	# A .nojekyll file tells Github pages to bypass Jekyll processing
+	git clone -b gh-pages --single-branch --no-checkout --depth 1 $(GITHUBORG)/$(SPHINXPROJ) _build/gh_pages
+
+	# Add a .nojekyll file to tell Github pages to bypass Jekyll processing
 	touch _build/gh_pages/.nojekyll
-	# Build the sphinx site
-	make html
+
 	# Copy site into the gh-pages branch folder, then push to Github to deploy
 	cd _build/ && \
 	cp -r html/* gh_pages && \
 	cd gh_pages && \
 	git add * && \
 	git add .nojekyll && \
-	git commit -a -m 'Make install' && \
+	git commit -a -m 'deploy docsite' && \
 	git push
+
+# Clean & rebuild the html site, then deploy docsite
+install:
+	make clean
+	make html
+	make deploy