diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..75ec69b23 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +en/_exts/configurationblock.pyc +build \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 000000000..4315116f8 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# Doctrine ORM Documentation + +## How to Generate + +1. Run ./bin/install-dependencies.sh +2. Run ./bin/generate-docs.sh + +It will generate the documentation into the build directory of the checkout. \ No newline at end of file diff --git a/bin/generate-docs.sh b/bin/generate-docs.sh new file mode 100755 index 000000000..7d06d2a8d --- /dev/null +++ b/bin/generate-docs.sh @@ -0,0 +1,10 @@ +#!/bin/bash +EXECPATH=`dirname $0` +cd $EXECPATH +cd .. + +rm build -Rf +sphinx-build en build + +sphinx-build -b latex en build/pdf +rubber --into build/pdf --pdf build/pdf/Doctrine2ORM.tex \ No newline at end of file diff --git a/bin/install-dependencies.sh b/bin/install-dependencies.sh new file mode 100644 index 000000000..86b3bdff7 --- /dev/null +++ b/bin/install-dependencies.sh @@ -0,0 +1,4 @@ +#!/bin/bash +sudo apt-get install python25 python25-dev texlive-full rubber +sudo easy_install pygments +sudo easy_install sphinx \ No newline at end of file diff --git a/convert.sh b/convert.sh deleted file mode 100755 index 27e4a5b85..000000000 --- a/convert.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash -FILES=`find -iname *.txt -print` -for FILE in $FILES -do - # replace the + to # chars - sed -i -r 's/^([+]{4})\s/#### /' $FILE - sed -i -r 's/^([+]{3})\s/### /' $FILE - sed -i -r 's/^([+]{2})\s/## /' $FILE - sed -i -r 's/^([+]{1})\s/# /' $FILE - sed -i -r 's/(\[php\])/ ${FILE%.txt}.rst -done \ No newline at end of file diff --git a/en/conf.py b/en/conf.py index a0192a66a..09d8c262f 100644 --- a/en/conf.py +++ b/en/conf.py @@ -38,20 +38,20 @@ master_doc = 'index' # General information about the project. project = u'Doctrine 2 ORM' -copyright = u'2010, Doctrine Project Team' +copyright = u'2010-11, Doctrine Project Team' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '2.0' +version = '2.1' # The full version, including alpha/beta/rc tags. -release = '2.0.0' +release = '2.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -language = 'php' +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: diff --git a/generate-docs.sh b/generate-docs.sh deleted file mode 100755 index 33e811f6c..000000000 --- a/generate-docs.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -sphinx-build en /var/www/docs