Permalink
Browse files

Add 'docs/' from commit '8fcf2d45019bf38a1df728353a1e417343c69cfb'

git-subtree-dir: docs
git-subtree-mainline: 271bd37
git-subtree-split: 8fcf2d4
  • Loading branch information...
2 parents 271bd37 + 8fcf2d4 commit cbcc693e365c0436f06b0eb498f18d51bf6e3fae @beberlei beberlei committed Jan 23, 2013
Showing with 20,273 additions and 0 deletions.
  1. +4 −0 docs/.gitignore
  2. +3 −0 docs/.gitmodules
  3. +8 −0 docs/README.md
  4. +10 −0 docs/bin/generate-docs.sh
  5. +4 −0 docs/bin/install-dependencies.sh
  6. +89 −0 docs/en/Makefile
  7. +93 −0 docs/en/_exts/configurationblock.py
  8. +1 −0 docs/en/_theme
  9. +194 −0 docs/en/conf.py
  10. +256 −0 docs/en/cookbook/advanced-field-value-conversion-using-custom-mapping-types.rst
  11. +376 −0 docs/en/cookbook/aggregate-fields.rst
  12. +273 −0 docs/en/cookbook/decorator-pattern.rst
  13. +217 −0 docs/en/cookbook/dql-custom-walkers.rst
  14. +240 −0 docs/en/cookbook/dql-user-defined-functions.rst
  15. +68 −0 docs/en/cookbook/entities-in-session.rst
  16. +112 −0 docs/en/cookbook/implementing-arrayaccess-for-domain-objects.rst
  17. +72 −0 docs/en/cookbook/implementing-the-notify-changetracking-policy.rst
  18. +78 −0 docs/en/cookbook/implementing-wakeup-or-clone.rst
  19. +140 −0 docs/en/cookbook/integrating-with-codeigniter.rst
  20. +189 −0 docs/en/cookbook/mysql-enums.rst
  21. +136 −0 docs/en/cookbook/resolve-target-entity-listener.rst
  22. +80 −0 docs/en/cookbook/sql-table-prefixes.rst
  23. +254 −0 docs/en/cookbook/strategy-cookbook-introduction.rst
  24. +137 −0 docs/en/cookbook/validation-of-entities.rst
  25. +168 −0 docs/en/cookbook/working-with-datetime.rst
  26. +127 −0 docs/en/index.rst
  27. +113 −0 docs/en/make.bat
  28. +1,113 −0 docs/en/reference/annotations-reference.rst
  29. +197 −0 docs/en/reference/architecture.rst
  30. +1,144 −0 docs/en/reference/association-mapping.rst
  31. +675 −0 docs/en/reference/basic-mapping.rst
  32. +177 −0 docs/en/reference/batch-processing.rst
  33. +127 −0 docs/en/reference/best-practices.rst
  34. +493 −0 docs/en/reference/caching.rst
  35. +151 −0 docs/en/reference/change-tracking-policies.rst
  36. +590 −0 docs/en/reference/configuration.rst
  37. +1,667 −0 docs/en/reference/dql-doctrine-query-language.rst
  38. +658 −0 docs/en/reference/events.rst
  39. +224 −0 docs/en/reference/faq.rst
  40. +91 −0 docs/en/reference/filters.rst
  41. +64 −0 docs/en/reference/improving-performance.rst
  42. +559 −0 docs/en/reference/inheritance-mapping.rst
  43. +93 −0 docs/en/reference/installation.rst
  44. +189 −0 docs/en/reference/limitations-and-known-issues.rst
  45. +194 −0 docs/en/reference/metadata-drivers.rst
  46. +148 −0 docs/en/reference/namingstrategy.rst
  47. +870 −0 docs/en/reference/native-sql.rst
  48. +90 −0 docs/en/reference/partial-objects.rst
  49. +310 −0 docs/en/reference/php-mapping.rst
  50. +541 −0 docs/en/reference/query-builder.rst
  51. +526 −0 docs/en/reference/tools.rst
  52. +353 −0 docs/en/reference/transactions-and-concurrency.rst
  53. +60 −0 docs/en/reference/unitofwork-associations.rst
  54. +201 −0 docs/en/reference/unitofwork.rst
  55. +712 −0 docs/en/reference/working-with-associations.rst
  56. +848 −0 docs/en/reference/working-with-objects.rst
  57. +747 −0 docs/en/reference/xml-mapping.rst
  58. +119 −0 docs/en/reference/yaml-mapping.rst
  59. +80 −0 docs/en/toc.rst
  60. +351 −0 docs/en/tutorials/composite-primary-keys.rst
  61. +82 −0 docs/en/tutorials/extra-lazy-associations.rst
  62. +27 −0 docs/en/tutorials/getting-started-database.rst
  63. +24 −0 docs/en/tutorials/getting-started-models.rst
  64. +1,516 −0 docs/en/tutorials/getting-started.rst
  65. +300 −0 docs/en/tutorials/in-ten-quick-steps.rst
  66. +91 −0 docs/en/tutorials/ordered-associations.rst
  67. +90 −0 docs/en/tutorials/override-field-association-mappings-in-subclasses.rst
  68. +41 −0 docs/en/tutorials/pagination.rst
  69. +298 −0 docs/en/tutorials/working-with-indexed-associations.rst
View
@@ -0,0 +1,4 @@
+en/_exts/configurationblock.pyc
+build
+en/_build
+.idea
View
@@ -0,0 +1,3 @@
+[submodule "en/_theme"]
+ path = en/_theme
+ url = https://github.com/doctrine/doctrine-sphinx-theme.git
View
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Doctrine2ORM.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Doctrine2ORM.qhc"
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
@@ -0,0 +1,93 @@
+#Copyright (c) 2010 Fabien Potencier
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is furnished
+#to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+#THE SOFTWARE.
+
+from docutils.parsers.rst import Directive, directives
+from docutils import nodes
+from string import upper
+
+class configurationblock(nodes.General, nodes.Element):
+ pass
+
+class ConfigurationBlock(Directive):
+ has_content = True
+ required_arguments = 0
+ optional_arguments = 0
+ final_argument_whitespace = True
+ option_spec = {}
+ formats = {
+ 'html': 'HTML',
+ 'xml': 'XML',
+ 'php': 'PHP',
+ 'yaml': 'YAML',
+ 'jinja': 'Twig',
+ 'html+jinja': 'Twig',
+ 'jinja+html': 'Twig',
+ 'php+html': 'PHP',
+ 'html+php': 'PHP',
+ 'ini': 'INI',
+ 'php-annotations': 'Annotations',
+ }
+
+ def run(self):
+ env = self.state.document.settings.env
+
+ node = nodes.Element()
+ node.document = self.state.document
+ self.state.nested_parse(self.content, self.content_offset, node)
+
+ entries = []
+ for i, child in enumerate(node):
+ if isinstance(child, nodes.literal_block):
+ # add a title (the language name) before each block
+ #targetid = "configuration-block-%d" % env.new_serialno('configuration-block')
+ #targetnode = nodes.target('', '', ids=[targetid])
+ #targetnode.append(child)
+
+ innernode = nodes.emphasis(self.formats[child['language']], self.formats[child['language']])
+
+ para = nodes.paragraph()
+ para += [innernode, child]
+
+ entry = nodes.list_item('')
+ entry.append(para)
+ entries.append(entry)
+
+ resultnode = configurationblock()
+ resultnode.append(nodes.bullet_list('', *entries))
+
+ return [resultnode]
+
+def visit_configurationblock_html(self, node):
+ self.body.append(self.starttag(node, 'div', CLASS='configuration-block'))
+
+def depart_configurationblock_html(self, node):
+ self.body.append('</div>\n')
+
+def visit_configurationblock_latex(self, node):
+ pass
+
+def depart_configurationblock_latex(self, node):
+ pass
+
+def setup(app):
+ app.add_node(configurationblock,
+ html=(visit_configurationblock_html, depart_configurationblock_html),
+ latex=(visit_configurationblock_latex, depart_configurationblock_latex))
+ app.add_directive('configuration-block', ConfigurationBlock)
Submodule _theme added at 5aa024
Oops, something went wrong.

0 comments on commit cbcc693

Please sign in to comment.