Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add 'docs/' from commit '8fcf2d45019bf38a1df728353a1e417343c69cfb'
- Loading branch information
Showing
69 changed files
with
20,273 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
en/_exts/configurationblock.pyc | ||
build | ||
en/_build | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "en/_theme"] | ||
path = en/_theme | ||
url = https://github.com/doctrine/doctrine-sphinx-theme.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/bash | ||
sudo apt-get install python25 python25-dev texlive-full rubber | ||
sudo easy_install pygments | ||
sudo easy_install sphinx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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.