aboutsummaryrefslogtreecommitdiff
path: root/development/Sphinx
diff options
context:
space:
mode:
authorMikko Värri <vmj@linuxbox.fi>2010-08-15 18:17:25 -0400
committerErik Hanson <erik@slackbuilds.org>2010-08-15 20:53:42 -0500
commit25fbd154803654b0ddaf3bda1e0a775cf578f924 (patch)
tree8e5bf9a57ad9ced16afedb8caf0a7a34177aa24c /development/Sphinx
parentc7d3396ba1876f60dd6f27d29103d025dabbf6e8 (diff)
development/Sphinx: Added (Documentation generator)
Signed-off-by: dsomero <xgizzmo@slackbuilds.org>
Diffstat (limited to 'development/Sphinx')
-rw-r--r--development/Sphinx/README23
-rw-r--r--development/Sphinx/Sphinx.SlackBuild58
-rw-r--r--development/Sphinx/Sphinx.info10
-rw-r--r--development/Sphinx/slack-desc19
4 files changed, 110 insertions, 0 deletions
diff --git a/development/Sphinx/README b/development/Sphinx/README
new file mode 100644
index 0000000000000..2468727d512cf
--- /dev/null
+++ b/development/Sphinx/README
@@ -0,0 +1,23 @@
+Sphinx (Documentation generator)
+
+Sphinx is a tool that translates a set of reStructuredText source
+files into various output formats, automatically producing
+cross-references, indices etc. The focus is on hand-written
+documentation, rather than auto-generated API docs. Though there is
+support for that kind of docs as well (which is intended to be
+freely mixed with hand-written content). If you need pure API docs
+have a look at Epydoc, which also understands reST.
+
+This requires pysetuptools, docutils, and Jinja2.
+
+Jinja2 circular dependencies warning:
+
+The DOCS=yes flag needs Sphinx to build python docs, it and needs Jinja2
+but that needs Sphinx because you have set its DOCS=yes flag.
+If you really need the docs build Jinja2 without the DOCS=yes flag
+build Sphinx then rebuild Jinja2 with DOCS=yes.
+
+Incidentally, unless you are a developer, you don't normally need the
+DOCS=yes flag.
+
+Optionally, Pygments can be used at runtime, if installed.
diff --git a/development/Sphinx/Sphinx.SlackBuild b/development/Sphinx/Sphinx.SlackBuild
new file mode 100644
index 0000000000000..dad5193441fd1
--- /dev/null
+++ b/development/Sphinx/Sphinx.SlackBuild
@@ -0,0 +1,58 @@
+#!/bin/sh
+
+# Slackware build script for Sphinx
+
+# Written by Mikko Värri (vmj@linuxbox.fi)
+# Public domain.
+
+PRGNAM=Sphinx
+VERSION=${VERSION:-1.0.1}
+BUILD=${BUILD:-1}
+TAG=${TAG:-_SBo}
+
+if [ -z "$ARCH" ]; then
+ case "$( uname -m )" in
+ i?86) ARCH=i486 ;;
+ arm*) ARCH=arm ;;
+ *) ARCH=$( uname -m ) ;;
+ esac
+fi
+
+CWD=$(pwd)
+TMP=${TMP:-/tmp/SBo}
+PKG=$TMP/package-$PRGNAM
+OUTPUT=${OUTPUT:-/tmp}
+
+set -e
+
+rm -rf $PKG
+mkdir -p $TMP $PKG $OUTPUT
+cd $TMP
+rm -rf $PRGNAM-$VERSION
+tar xvf $CWD/$PRGNAM-$VERSION.tar.gz
+cd $PRGNAM-$VERSION
+chown -R root:root .
+find . \
+ \( -perm 777 -o -perm 775 -o -perm 711 -o -perm 555 -o -perm 511 \) \
+ -exec chmod 755 {} \; -o \
+ \( -perm 666 -o -perm 664 -o -perm 600 -o -perm 444 -o -perm 440 -o -perm 400 \) \
+ -exec chmod 644 {} \;
+
+python setup.py install --root=$PKG
+
+PYTHONPATH="../" \
+make -C doc SPHINXBUILD="python ../sphinx-build.py" html
+
+find $PKG | xargs file | grep -e "executable" -e "shared object" | grep ELF \
+ | cut -f 1 -d : | xargs strip --strip-unneeded 2> /dev/null || true
+
+mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
+cp -a AUTHORS CHANGES EXAMPLES LICENSE README doc/_build/html \
+ $PKG/usr/doc/$PRGNAM-$VERSION
+cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
+
+mkdir -p $PKG/install
+cat $CWD/slack-desc > $PKG/install/slack-desc
+
+cd $PKG
+/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.${PKGTYPE:-tgz}
diff --git a/development/Sphinx/Sphinx.info b/development/Sphinx/Sphinx.info
new file mode 100644
index 0000000000000..4bacd11b20ccd
--- /dev/null
+++ b/development/Sphinx/Sphinx.info
@@ -0,0 +1,10 @@
+PRGNAM="Sphinx"
+VERSION="1.0.1"
+HOMEPAGE="http://sphinx.pocoo.org/"
+DOWNLOAD="http://pypi.python.org/packages/source/S/Sphinx/Sphinx-1.0.1.tar.gz"
+MD5SUM="d3a57ffcf2592da494aeca4b62e815ef"
+DOWNLOAD_x86_64=""
+MD5SUM_x86_64=""
+MAINTAINER="Mikko Värri"
+EMAIL="vmj@linuxbox.fi"
+APPROVED="dsomero"
diff --git a/development/Sphinx/slack-desc b/development/Sphinx/slack-desc
new file mode 100644
index 0000000000000..cc6a8f35e629a
--- /dev/null
+++ b/development/Sphinx/slack-desc
@@ -0,0 +1,19 @@
+# HOW TO EDIT THIS FILE:
+# The "handy ruler" below makes it easier to edit a package description. Line
+# up the first '|' above the ':' following the base package name, and the '|'
+# on the right side marks the last column you can put a character in. You must
+# make exactly 11 lines for the formatting to be correct. It's also
+# customary to leave one space after the ':'.
+
+ |-----handy-ruler------------------------------------------------------|
+Sphinx: Sphinx (Documentation generator)
+Sphinx:
+Sphinx: Sphinx is a tool that translates a set of reStructuredText source
+Sphinx: files into various output formats, automatically producing
+Sphinx: cross-references, indices etc. The focus is on hand-written
+Sphinx: documentation, rather than auto-generated API docs. Though there is
+Sphinx: support for that kind of docs as well (which is intended to be
+Sphinx: freely mixed with hand-written content). If you need pure API docs
+Sphinx: have a look at Epydoc, which also understands reST.
+Sphinx:
+Sphinx: