Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Copy new build process for docs into orm docs from DBAL

  • Loading branch information...
commit d8125768a32780dcf5bdaa4c0b5b53e8500d0127 1 parent 91b2c82
@beberlei beberlei authored
View
2  .gitignore
@@ -0,0 +1,2 @@
+en/_exts/configurationblock.pyc
+build
View
8 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.
View
10 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
View
4 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
View
14 convert.sh
@@ -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\])/<?php/' $FILE
-
- # convert markdown to reStructured Text
- pandoc -f markdown -t rst $FILE > ${FILE%.txt}.rst
-done
View
8 en/conf.py
@@ -38,20 +38,20 @@
# 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:
View
2  generate-docs.sh
@@ -1,2 +0,0 @@
-#!/bin/bash
-sphinx-build en /var/www/docs

0 comments on commit d812576

Please sign in to comment.
Something went wrong with that request. Please try again.