Skip to content
This repository
Browse code

Copy new build process for docs into orm docs from DBAL

  • Loading branch information...
commit d8125768a32780dcf5bdaa4c0b5b53e8500d0127 1 parent 91b2c82
Benjamin Eberlei beberlei authored
2  .gitignore
... ... @@ -0,0 +1,2 @@
  1 +en/_exts/configurationblock.pyc
  2 +build
8 README.md
Source Rendered
... ... @@ -0,0 +1,8 @@
  1 +# Doctrine ORM Documentation
  2 +
  3 +## How to Generate
  4 +
  5 +1. Run ./bin/install-dependencies.sh
  6 +2. Run ./bin/generate-docs.sh
  7 +
  8 +It will generate the documentation into the build directory of the checkout.
10 bin/generate-docs.sh
... ... @@ -0,0 +1,10 @@
  1 +#!/bin/bash
  2 +EXECPATH=`dirname $0`
  3 +cd $EXECPATH
  4 +cd ..
  5 +
  6 +rm build -Rf
  7 +sphinx-build en build
  8 +
  9 +sphinx-build -b latex en build/pdf
  10 +rubber --into build/pdf --pdf build/pdf/Doctrine2ORM.tex
4 bin/install-dependencies.sh
... ... @@ -0,0 +1,4 @@
  1 +#!/bin/bash
  2 +sudo apt-get install python25 python25-dev texlive-full rubber
  3 +sudo easy_install pygments
  4 +sudo easy_install sphinx
14 convert.sh
... ... @@ -1,14 +0,0 @@
1   -#!/bin/bash
2   -FILES=`find -iname *.txt -print`
3   -for FILE in $FILES
4   -do
5   - # replace the + to # chars
6   - sed -i -r 's/^([+]{4})\s/#### /' $FILE
7   - sed -i -r 's/^([+]{3})\s/### /' $FILE
8   - sed -i -r 's/^([+]{2})\s/## /' $FILE
9   - sed -i -r 's/^([+]{1})\s/# /' $FILE
10   - sed -i -r 's/(\[php\])/<?php/' $FILE
11   -
12   - # convert markdown to reStructured Text
13   - pandoc -f markdown -t rst $FILE > ${FILE%.txt}.rst
14   -done
8 en/conf.py
@@ -38,20 +38,20 @@
38 38
39 39 # General information about the project.
40 40 project = u'Doctrine 2 ORM'
41   -copyright = u'2010, Doctrine Project Team'
  41 +copyright = u'2010-11, Doctrine Project Team'
42 42
43 43 # The version info for the project you're documenting, acts as replacement for
44 44 # |version| and |release|, also used in various other places throughout the
45 45 # built documents.
46 46 #
47 47 # The short X.Y version.
48   -version = '2.0'
  48 +version = '2.1'
49 49 # The full version, including alpha/beta/rc tags.
50   -release = '2.0.0'
  50 +release = '2.1'
51 51
52 52 # The language for content autogenerated by Sphinx. Refer to documentation
53 53 # for a list of supported languages.
54   -language = 'php'
  54 +language = 'en'
55 55
56 56 # There are two options for replacing |today|: either, you set today to some
57 57 # non-false value, then it is used:
2  generate-docs.sh
... ... @@ -1,2 +0,0 @@
1   -#!/bin/bash
2   -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.