Merge pull request #1 from symfony/master

Merge from symfony-docs

Author: TerjeBr

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,12 @@
+Code of Conduct
+===============
+
+This project follows a [Code of Conduct][code_of_conduct] in order to ensure an
+open and welcoming environment. Please read the full text for understanding the
+accepted and unaccepted behavior.
+
+Please read also the [reporting guidelines][guidelines], in case you encountered
+or witnessed any misbehavior.
+
+[code_of_conduct]: https://symfony.com/doc/current/contributing/code_of_conduct/code_of_conduct.html
+[guidelines]: https://symfony.com/doc/current/contributing/code_of_conduct/reporting_guidelines.html

.github/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+Contributing
+------------
+
+We love contributors! For more information on how you can contribute to the
+Symfony documentation, please read [Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html).

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+<!--
+
+If your pull request fixes a BUG, use the oldest maintained branch that contains
+the bug (see https://symfony.com/roadmap for the list of maintained branches).
+
+If your pull request documents a NEW FEATURE, use the same Symfony branch where
+the feature was introduced (and `master` for features of unreleased versions).
+
+-->

.gitignore

@@ -1,2 +1,3 @@
-/_build
-/_exts
+/_build/doctrees
+/_build/html
+*.pyc

.gitmodules

@@ -0,0 +1,61 @@
+# This file describes an application. You can have multiple applications
+# in the same project.
+
+# The name of this app. Must be unique within a project.
+name: symfonydocs
+
+# The toolstack used to build the application.
+type: "php"
+
+build:
+    flavor: "composer"
+
+# The configuration of app when it is exposed to the web.
+web:
+    # The public directory of the app, relative to its root.
+    document_root: "/_build/html"
+    index_files:
+      - index.html
+    whitelist:
+      - \.html$
+      - \.txt$
+
+      # CSS and Javascript.
+      - \.css$
+      - \.js$
+      - \.hbs$
+
+      # image/* types.
+      - \.gif$
+      - \.png$
+      - \.ico$
+      - \.svgz?$
+
+      # fonts types.
+      - \.ttf$
+      - \.eot$
+      - \.woff$
+      - \.otf$
+
+      # robots.txt.
+      - /robots\.txt$
+
+# The size of the persistent disk of the application (in MB).
+disk: 512
+
+# Build time dependencies.
+dependencies:
+  python:
+    virtualenv: 15.1.0
+
+# The hooks that will be performed when the package is deployed.
+hooks:
+    build: |
+      virtualenv .virtualenv
+      . .virtualenv/bin/activate
+      # Platform.sh currently sets PIP_USER=1.
+      export PIP_USER=
+      pip install pip==9.0.1 wheel==0.29.0
+      pip install -r _build/.requirements.txt
+      find .virtualenv -type f -name "*.rst" -delete
+      make -C _build html

.platform.app.yaml

@@ -0,0 +1,16 @@
+http://www.{default}/:
+  to: http://{default}/
+  type: redirect
+http://{default}/:
+  cache:
+    cookies:
+    - '*'
+    default_ttl: 0
+    enabled: true
+    headers:
+    - Accept
+    - Accept-Language
+  ssi:
+    enabled: false
+  type: upstream
+  upstream: symfonydocs:php

.platform/routes.yaml

@@ -0,0 +1 @@
+# Keeping this file empty to not deploy unused services.

.platform/services.yaml

@@ -1,16 +1,15 @@
 language: python
 
-python:
-    - "2.7"
+python: 2.7
 
 sudo: false
+cache:
+  directories: [$HOME/.cache/pip]
 
-install: 
-    - "pip install -q -r requirements.txt --use-mirrors"
+install: pip install -r _build/.requirements.txt
 
-script: sphinx-build -nW -b html -d _build/doctrees . _build/html
+script: make -C _build SPHINXOPTS=-nW html
 
 branches:
   except:
     - github-comments
-

.travis.yml

@@ -1,16 +1,21 @@
 Symfony Documentation
 =====================
 
-This documentation is rendered online at http://symfony.com/doc/current/
+This documentation is rendered online at https://symfony.com/doc/current/
 
 Contributing
 ------------
 
 >**Note**
->Unless you're documenting a feature that was introduced *after* Symfony 2.3 
->(e.g. in Symfony 2.4), all pull requests must be based off of the **2.3** branch,
+>Unless you're documenting a feature that was introduced *after* Symfony 2.7
+>(e.g. in Symfony 2.8), all pull requests must be based off of the **2.7** branch,
 >**not** the master or older branches.
 
 We love contributors! For more information on how you can contribute to the
 Symfony documentation, please read
-[Contributing to the Documentation](http://symfony.com/doc/current/contributing/documentation/overview.html)
+[Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html)
+
+Platform.sh
+-----------
+
+Pull requests are automatically built by [Platform.sh](https://platform.sh).

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+alabaster==0.7.10
+Babel==2.4.0
+docutils==0.13.1
+imagesize==0.7.1
+Jinja2==2.9.6
+MarkupSafe==1.0
+Pygments==2.2.0
+pytz==2017.2
+requests==2.12.5
+six==1.10.0
+snowballstemmer==1.2.1
+Sphinx==1.3.6
+git+https://github.com/fabpot/sphinx-php.git@7312eccce9465640752e51373a480da700e02345#egg_name=sphinx-php

README.markdown

@@ -5,12 +5,12 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = .
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
 PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -c $(BUILDDIR) -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ../
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 

_build/.requirements.txt

@@ -0,0 +1,167 @@
+from sphinx.highlighting import lexers, PygmentsBridge
+from pygments.style import Style
+from pygments.formatters import HtmlFormatter
+from pygments.token import Keyword, Name, Comment, String, Error, \
+     Number, Operator, Generic, Whitespace, Punctuation, Other, Literal
+
+from sphinx.writers.html import HTMLTranslator
+from docutils import nodes
+from sphinx.locale import admonitionlabels, lazy_gettext
+
+customadmonitionlabels = admonitionlabels
+l_ = lazy_gettext
+customadmonitionlabels['best-practice'] = l_('Best Practice')
+
+def _getType(path):
+    return path[:path.find('/')]
+
+def _isIndex(path):
+    return 'index' in path
+
+class SensioHTMLTranslator(HTMLTranslator):
+    def __init__(self, builder, *args, **kwds):
+        HTMLTranslator.__init__(self, builder, *args, **kwds)
+        builder.templates.environment.filters['get_type'] = _getType
+        builder.templates.environment.tests['index'] = _isIndex
+        self.highlightlinenothreshold = 0
+
+    def visit_literal(self, node):
+        self.body.append(self.starttag(node, 'tt', '', CLASS='docutils literal'))
+        self.body.append('<code>')
+
+    def depart_literal(self, node):
+        self.body.append('</code>')
+        self.body.append('</tt>')
+
+    def visit_admonition(self, node, name=''):
+        self.body.append(self.starttag(node, 'div', CLASS=('admonition-wrapper')))
+        self.body.append('<div class="' + name + '"></div>')
+        self.body.append('<div class="admonition admonition-' + name + '">')
+        if name and name != 'seealso':
+            node.insert(0, nodes.title(name, customadmonitionlabels[name]))
+        self.set_first_last(node)
+
+    def depart_admonition(self, node=None):
+        self.body.append('</div></div>\n')
+
+    def visit_sidebar(self, node):
+        self.body.append(self.starttag(node, 'div', CLASS=('admonition-wrapper')))
+        self.body.append('<div class="sidebar"></div>')
+        self.body.append('<div class="admonition admonition-sidebar">')
+        self.set_first_last(node)
+        self.in_sidebar = 1
+
+    def depart_sidebar(self, node):
+        self.body.append('</div></div>\n')
+        self.in_sidebar = None
+
+    # overriden to add a new highlight div around each block
+    def visit_literal_block(self, node):
+        if node.rawsource != node.astext():
+            # most probably a parsed-literal block -- don't highlight
+            return BaseTranslator.visit_literal_block(self, node)
+        lang = self.highlightlang
+        linenos = node.rawsource.count('\n') >= \
+                  self.highlightlinenothreshold - 1
+        highlight_args = node.get('highlight_args', {})
+        if node.has_key('language'):
+            # code-block directives
+            lang = node['language']
+            highlight_args['force'] = True
+        if node.has_key('linenos'):
+            linenos = node['linenos']
+        def warner(msg):
+            self.builder.warn(msg, (self.builder.current_docname, node.line))
+        highlighted = self.highlighter.highlight_block(
+            node.rawsource, lang, warn=warner, linenos=linenos,
+            **highlight_args)
+        starttag = self.starttag(node, 'div', suffix='',
+                                 CLASS='highlight-%s' % lang)
+        self.body.append('<div class="literal-block">' + starttag + highlighted + '</div></div>\n')
+        raise nodes.SkipNode
+
+class SensioStyle(Style):
+    background_color = "#000000"
+    default_style = ""
+
+    styles = {
+        # No corresponding class for the following:
+        #Text: "", # class: ''
+        Whitespace: "underline #f8f8f8", # class: 'w'
+        Error: "#a40000 border:#ef2929", # class: 'err'
+        Other: "#ffffff", # class 'x'
+
+    Comment: "italic #B729D9", # class: 'c'
+    Comment.Single: "italic #B729D9", # class: 'c1'
+    Comment.Multiline: "italic #B729D9", # class: 'cm'
+    Comment.Preproc: "noitalic #aaa", # class: 'cp'
+
+    Keyword: "#FF8400", # class: 'k'
+        Keyword.Constant: "#FF8400", # class: 'kc'
+        Keyword.Declaration: "#FF8400", # class: 'kd'
+        Keyword.Namespace: "#FF8400", # class: 'kn'
+        Keyword.Pseudo: "#FF8400", # class: 'kp'
+        Keyword.Reserved: "#FF8400", # class: 'kr'
+        Keyword.Type: "#FF8400", # class: 'kt'
+
+    Operator: "#E0882F", # class: 'o'
+    Operator.Word: "#E0882F", # class: 'ow' - like keywords
+
+    Punctuation: "#999999", # class: 'p'
+
+        # because special names such as Name.Class, Name.Function, etc.
+        # are not recognized as such later in the parsing, we choose them
+        # to look the same as ordinary variables.
+        Name: "#ffffff", # class: 'n'
+    Name.Attribute: "#ffffff", # class: 'na' - to be revised
+    Name.Builtin: "#ffffff", # class: 'nb'
+        Name.Builtin.Pseudo: "#3465a4", # class: 'bp'
+    Name.Class: "#ffffff", # class: 'nc' - to be revised
+        Name.Constant: "#ffffff", # class: 'no' - to be revised
+        Name.Decorator: "#888", # class: 'nd' - to be revised
+        Name.Entity: "#ce5c00", # class: 'ni'
+        Name.Exception: "#cc0000", # class: 'ne'
+    Name.Function: "#ffffff", # class: 'nf'
+        Name.Property: "#ffffff", # class: 'py'
+        Name.Label: "#f57900", # class: 'nl'
+        Name.Namespace: "#ffffff", # class: 'nn' - to be revised
+    Name.Other: "#ffffff", # class: 'nx'
+    Name.Tag: "#cccccc", # class: 'nt' - like a keyword
+    Name.Variable: "#ffffff", # class: 'nv' - to be revised
+        Name.Variable.Class: "#ffffff", # class: 'vc' - to be revised
+        Name.Variable.Global: "#ffffff", # class: 'vg' - to be revised
+        Name.Variable.Instance: "#ffffff", # class: 'vi' - to be revised
+
+    Number: "#1299DA", # class: 'm'
+
+        Literal: "#ffffff", # class: 'l'
+        Literal.Date: "#ffffff", # class: 'ld'
+
+        String: "#56DB3A", # class: 's'
+        String.Backtick: "#56DB3A", # class: 'sb'
+        String.Char: "#56DB3A", # class: 'sc'
+    String.Doc: "italic #B729D9", # class: 'sd' - like a comment
+        String.Double: "#56DB3A", # class: 's2'
+        String.Escape: "#56DB3A", # class: 'se'
+        String.Heredoc: "#56DB3A", # class: 'sh'
+        String.Interpol: "#56DB3A", # class: 'si'
+        String.Other: "#56DB3A", # class: 'sx'
+        String.Regex: "#56DB3A", # class: 'sr'
+    String.Single: "#56DB3A", # class: 's1'
+        String.Symbol: "#56DB3A", # class: 'ss'
+
+        Generic: "#ffffff", # class: 'g'
+        Generic.Deleted: "#a40000", # class: 'gd'
+        Generic.Emph: "italic #ffffff", # class: 'ge'
+        Generic.Error: "#ef2929", # class: 'gr'
+        Generic.Heading: "#000080", # class: 'gh'
+        Generic.Inserted: "#00A000", # class: 'gi'
+        Generic.Output: "#888", # class: 'go'
+        Generic.Prompt: "#745334", # class: 'gp'
+        Generic.Strong: "bold #ffffff", # class: 'gs'
+        Generic.Subheading: "bold #800080", # class: 'gu'
+        Generic.Traceback: "bold #a40000", # class: 'gt'
+    }
+
+def setup(app):
+    app.set_translator('html', SensioHTMLTranslator)

Makefile renamed to _build/Makefile

@@ -0,0 +1,23 @@
+from pygments.lexer import RegexLexer, bygroups, using
+from pygments.token import *
+from pygments.lexers.shell import BashLexer, BatchLexer
+
+class TerminalLexer(RegexLexer):
+    name = 'Terminal'
+    aliases = ['terminal']
+    filenames = []
+
+    tokens = {
+        'root': [
+            ('^\$', Generic.Prompt, 'bash-prompt'),
+            ('^[^\n>]+>', Generic.Prompt, 'dos-prompt'),
+            ('^#.+$', Comment.Single),
+            ('^.+$', Generic.Output),
+        ],
+        'bash-prompt': [
+            ('(.+)$', bygroups(using(BashLexer)), '#pop')
+        ],
+        'dos-prompt': [
+            ('(.+)$', bygroups(using(BatchLexer)), '#pop')
+        ],
+    }