From 62204d06d959fdd19b64c5b075bfb30c5607be9a Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Fri, 30 Aug 2019 19:55:06 -0700 Subject: [PATCH] update sphinx docs --- commit-gh.sh | 45 +++++++++++++++++++++++++++++++++++++++++ debian/copyright | 2 +- documentation/Makefile | 2 +- documentation/conf.py | 4 ++-- documentation/index.rst | 2 +- 5 files changed, 50 insertions(+), 5 deletions(-) create mode 100755 commit-gh.sh diff --git a/commit-gh.sh b/commit-gh.sh new file mode 100755 index 0000000..3e97f83 --- /dev/null +++ b/commit-gh.sh @@ -0,0 +1,45 @@ +#!/bin/sh +set -e -x +# Usage: commit-gh +# +# Creates a commit containing only the files in the sub-directory provided as an argument +# +# Does not disturb the working copy or index + +[ -d "$1" ] || exit 1 + +# Commit to this branch +BRANCH=refs/heads/gh-pages + +# Use the main branch description as the gh-pages commit message +MSG=`git describe --tags --always` + +# Scratch space +TDIR=`mktemp -d -p $PWD` + +# Automatic cleanup of scratch space +trap 'rm -rf $TDIR' INT TERM QUIT EXIT + +export GIT_INDEX_FILE="$TDIR/index" + + +# Add listed files to a new (empty) index +find "$1" -type f -print0 | xargs -0 git update-index --add + +# Write the index into the repo, get tree hash +TREE=`git write-tree --prefix="$1"` + +echo "TREE $TREE" +git cat-file -p $TREE + +# Create a commit with our new tree +# Reference current branch head as parent (if any) +CMT=`git commit-tree -m "$MSG" $TREE` + +echo "COMMIT $CMT" +git cat-file -p $CMT + +# Update the branch with the new commit tree hash +git update-ref $BRANCH $CMT + +echo "Done" diff --git a/debian/copyright b/debian/copyright index f2ec6a9..f59d1b0 100644 --- a/debian/copyright +++ b/debian/copyright @@ -4,7 +4,7 @@ Upstream-Contact: Michael Davidsaver Source: http://mdavidsaver.github.io/pyDevSup/ Files: * -Copyright: Copyright 2016 Michael Davidsaver +Copyright: Copyright 2019 Michael Davidsaver License: GPL-2 On Debian systems, the full text of the GNU General Public License version 2 can be found in the file diff --git a/documentation/Makefile b/documentation/Makefile index 6c99b49..4134ba0 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = sphinx-build +SPHINXBUILD = $(PYTHON) -m sphinx PAPER = BUILDDIR = _build diff --git a/documentation/conf.py b/documentation/conf.py index 49af58c..a296c44 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -91,7 +91,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'alabaster' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -248,7 +248,7 @@ texinfo_documents = [ epub_title = u'pyDevSup' epub_author = u'Michael Davidsaver' epub_publisher = u'Michael Davidsaver' -epub_copyright = u'2013, Michael Davidsaver' +epub_copyright = u'2019, Michael Davidsaver' # The language of the text. It defaults to the language option # or en if the language is not set. diff --git a/documentation/index.rst b/documentation/index.rst index b3345f3..cdc2872 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -8,7 +8,7 @@ pydevsup documentation *pyDevSup* is a means of writing EPICS device support code in Python. -It currently supports EPICS >=3.14.11 and python versions: 2.6, 2.7, and 3.2. +It currently supports EPICS >=3.14.12 and python versions: 2.7, and >=3.2. The numpy package is also required. The source can be found at http://github.com/mdavidsaver/pyDevSup