Skip to content

Commit

Permalink
BLD/DOC: Automatically generate list of contributors.
Browse files Browse the repository at this point in the history
  • Loading branch information
Debilski committed Jul 27, 2015
1 parent 05b7061 commit a0d0a59
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 23 deletions.
20 changes: 2 additions & 18 deletions doc/source/info.rst
Expand Up @@ -5,24 +5,8 @@ Project Information
Authors and Contributors
========================

As of ``v0.2.0-177`` the developers and contributors are::

zsh» git shortlog -sn | cut -f1 --complement
Rike-Benjamin Schuppner
Valentin Haenel
Tiziano Zito
Zbigniew Jędrzejewski-Szmek
Bastian Venthur
Pietro Berkes
Nicola Chiapolini
Pauli Virtanen
abject
Christian Steigies
Sasza Kijek
Francesc Alted
Ola Pidde
Bartosz Telenczuk
Anna Chabuda
.. include:: _contributors.rst


Getting in Touch
================
Expand Down
19 changes: 14 additions & 5 deletions make-doc-tree.sh
Expand Up @@ -4,8 +4,6 @@
# to a git tree. See http://ASPP.github.com/pelita/development.rst
# for more information.

FILE=$1

# check, if index is empty
if ! git diff-index --cached --quiet --ignore-submodules HEAD ; then
echo "Fatal: cannot work with indexed files!"
Expand All @@ -15,6 +13,14 @@ fi
# get the 'git describe' output
git_describe=$(git describe)


# Generate _contributors.rst
CONTRIBUTORS=doc/source/_contributors.rst

echo "As of \`\`${git_describe}\`\` the developers and contributors are::" > $CONTRIBUTORS
echo "" >> $CONTRIBUTORS
git shortlog -sn | awk '{first = $1; $1 = " "; print $0; }' >> $CONTRIBUTORS

# make the documentation, hope it doesn't fail
echo "Generating doc from $git_describe"
(cd doc; git clean -n -x -d)
Expand All @@ -39,6 +45,9 @@ tree=$(git write-tree --prefix=$docdirectory)
# reset the index
git reset HEAD

echo "New tree $tree. Writing to file $FILE"

echo $tree > $1
if [ "$#" -eq 1 ]; then
echo "New tree $tree. Writing to file $FILE"
echo $tree > $1
else
echo "New tree $tree."
fi

0 comments on commit a0d0a59

Please sign in to comment.