Copy new build process for docs into orm docs from DBAL
This commit is contained in:
parent
91b2c82c58
commit
d8125768a3
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
en/_exts/configurationblock.pyc
|
||||
build
|
8
README.md
Normal file
8
README.md
Normal file
@ -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.
|
10
bin/generate-docs.sh
Executable file
10
bin/generate-docs.sh
Executable file
@ -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
|
4
bin/install-dependencies.sh
Normal file
4
bin/install-dependencies.sh
Normal file
@ -0,0 +1,4 @@
|
||||
#!/bin/bash
|
||||
sudo apt-get install python25 python25-dev texlive-full rubber
|
||||
sudo easy_install pygments
|
||||
sudo easy_install sphinx
|
14
convert.sh
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
|
@ -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:
|
||||
|
@ -1,2 +0,0 @@
|
||||
#!/bin/bash
|
||||
sphinx-build en /var/www/docs
|
Loading…
x
Reference in New Issue
Block a user