Skip to content

Commit 1b7e11a

Browse files
SimonHeimbergSimonHeimberg
committed
Merge branch '2.8' into profilerStopwatch
2 parents 5f01600 + 01db1c4 commit 1b7e11a

File tree

824 files changed

+45441
-34925
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

824 files changed

+45441
-34925
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Code of Conduct
2+
===============
3+
4+
This project follows a [Code of Conduct][code_of_conduct] in order to ensure an
5+
open and welcoming environment. Please read the full text for understanding the
6+
accepted and unaccepted behavior.
7+
8+
Please read also the [reporting guidelines][guidelines], in case you encountered
9+
or witnessed any misbehavior.
10+
11+
[code_of_conduct]: https://symfony.com/doc/current/contributing/code_of_conduct/code_of_conduct.html
12+
[guidelines]: https://symfony.com/doc/current/contributing/code_of_conduct/reporting_guidelines.html

‎CONTRIBUTING.md renamed to ‎.github/CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,4 @@ Contributing
22
------------
33

44
We love contributors! For more information on how you can contribute to the
5-
Symfony documentation, please read [Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html)
6-
and notice the [Pull Request Format](https://symfony.com/doc/current/contributing/documentation/overview.html#pull-request-format)
7-
that helps us merge your pull requests faster!
5+
Symfony documentation, please read [Contributing to the Documentation](https://symfony.com/doc/current/contributing/documentation/overview.html).

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!--
2+
3+
If your pull request fixes a BUG, use the oldest maintained branch that contains
4+
the bug (see https://symfony.com/roadmap for the list of maintained branches).
5+
6+
If your pull request documents a NEW FEATURE, use the same Symfony branch where
7+
the feature was introduced (and `master` for features of unreleased versions).
8+
9+
-->

‎.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
/_build
1+
/_build/doctrees
2+
/_build/html
23
*.pyc

‎.platform.app.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,16 @@ disk: 512
4646
# Build time dependencies.
4747
dependencies:
4848
python:
49-
sphinx: ">=1"
49+
virtualenv: 15.1.0
5050

5151
# The hooks that will be performed when the package is deployed.
5252
hooks:
5353
build: |
54-
pip install git+https://github.com/fabpot/sphinx-php.git
55-
make html
54+
virtualenv .virtualenv
55+
. .virtualenv/bin/activate
56+
# Platform.sh currently sets PIP_USER=1.
57+
export PIP_USER=
58+
pip install pip==9.0.1 wheel==0.29.0
59+
pip install -r _build/.requirements.txt
60+
find .virtualenv -type f -name "*.rst" -delete
61+
make -C _build html

‎.travis.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
language: python
22

3-
python: "2.7"
3+
python: 2.7
44

55
sudo: false
6-
76
cache:
8-
directories:
9-
- $HOME/.cache/pip
10-
- _build
7+
directories: [$HOME/.cache/pip]
118

12-
install: pip install sphinx~=1.3 git+https://github.com/fabpot/sphinx-php.git
9+
install: pip install -r _build/.requirements.txt
1310

14-
script: sphinx-build -nW -b html -d _build/doctrees . _build/html
11+
script: make -C _build SPHINXOPTS=-nW html
1512

1613
branches:
1714
except:

‎Dockerfile

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
FROM python:2-stretch as builder
2+
3+
WORKDIR /www
4+
5+
COPY ./_build/.requirements.txt _build/
6+
7+
RUN pip install pip==9.0.1 wheel==0.29.0 \
8+
&& pip install -r _build/.requirements.txt
9+
10+
COPY . /www
11+
12+
RUN make -C _build html
13+
14+
FROM nginx:latest
15+
16+
COPY --from=builder /www/_build/html /usr/share/nginx/html

‎README.markdown

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ Contributing
77
------------
88

99
>**Note**
10-
>Unless you're documenting a feature that was introduced *after* Symfony 2.3
11-
>(e.g. in Symfony 2.4), all pull requests must be based off of the **2.3** branch,
10+
>Unless you're documenting a feature that was introduced *after* Symfony 2.8
11+
>(e.g. in Symfony 3.4), all pull requests must be based off of the **2.8** branch,
1212
>**not** the master or older branches.
1313
1414
We love contributors! For more information on how you can contribute to the
@@ -19,3 +19,17 @@ Platform.sh
1919
-----------
2020

2121
Pull requests are automatically built by [Platform.sh](https://platform.sh).
22+
23+
Docker
24+
------
25+
26+
You can build the doc locally with these commands:
27+
28+
```bash
29+
# build the image...
30+
$ docker build . -t symfony-docs
31+
32+
# ...and serve it locally on http//:127.0.0.1:8080
33+
# (if it's already in use, change the '8080' port by any other port)
34+
$ docker run --rm -p 8080:80 symfony-docs
35+
```

‎_build/.requirements.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
alabaster==0.7.10
2+
Babel==2.4.0
3+
docutils==0.13.1
4+
imagesize==0.7.1
5+
Jinja2==2.9.6
6+
MarkupSafe==1.0
7+
Pygments==2.2.0
8+
pytz==2017.2
9+
requests==2.12.5
10+
six==1.10.0
11+
snowballstemmer==1.2.1
12+
Sphinx==1.3.6
13+
git+https://github.com/fabpot/sphinx-php.git@7312eccce9465640752e51373a480da700e02345#egg_name=sphinx-php

‎Makefile renamed to ‎_build/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
8-
BUILDDIR = _build
8+
BUILDDIR = .
99

1010
# Internal variables.
1111
PAPEROPT_a4 = -D latex_paper_size=a4
1212
PAPEROPT_letter = -D latex_paper_size=letter
13-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13+
ALLSPHINXOPTS = -c $(BUILDDIR) -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ../
1414
# the i18n builder cannot share the environment and doctrees with the others
1515
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1616

‎_theme/_exts/symfonycom/__init__.py renamed to ‎_build/_themes/_exts/symfonycom/__init__.py

File renamed without changes.

‎_theme/_exts/symfonycom/sphinx/__init__.py renamed to ‎_build/_themes/_exts/symfonycom/sphinx/__init__.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,14 @@ def __init__(self, builder, *args, **kwds):
2626
self.highlightlinenothreshold = 0
2727

2828
def visit_literal(self, node):
29-
self.body.append(self.starttag(node, 'tt', '', CLASS='docutils literal'))
30-
self.body.append('<code>')
29+
self.body.append(self.starttag(node, 'code', '', CLASS='docutils literal notranslate'))
3130

3231
def depart_literal(self, node):
3332
self.body.append('</code>')
34-
self.body.append('</tt>')
3533

3634
def visit_admonition(self, node, name=''):
3735
self.body.append(self.starttag(node, 'div', CLASS=('admonition-wrapper')))
38-
self.body.append('<div class="' + name + '"></div>')
39-
self.body.append('<div class="admonition admonition-' + name + '">')
36+
self.body.append('<div class="admonition ' + name + '">')
4037
if name and name != 'seealso':
4138
node.insert(0, nodes.title(name, customadmonitionlabels[name]))
4239
self.set_first_last(node)
@@ -46,7 +43,6 @@ def depart_admonition(self, node=None):
4643

4744
def visit_sidebar(self, node):
4845
self.body.append(self.starttag(node, 'div', CLASS=('admonition-wrapper')))
49-
self.body.append('<div class="sidebar"></div>')
5046
self.body.append('<div class="admonition admonition-sidebar">')
5147
self.set_first_last(node)
5248
self.in_sidebar = 1

‎_build/_themes/_exts/symfonycom/sphinx/lexer.py

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
from pygments.lexer import RegexLexer, bygroups, using
2+
from pygments.token import *
3+
from pygments.lexers.shell import BashLexer, BatchLexer
4+
5+
class TerminalLexer(RegexLexer):
6+
name = 'Terminal'
7+
aliases = ['terminal']
8+
filenames = []
9+
10+
tokens = {
11+
'root': [
12+
('^\$', Generic.Prompt, 'bash-prompt'),
13+
('^[^\n>]+>', Generic.Prompt, 'dos-prompt'),
14+
('^#.+$', Comment.Single),
15+
('^.+$', Generic.Output),
16+
],
17+
'bash-prompt': [
18+
('(.+)$', bygroups(using(BashLexer)), '#pop')
19+
],
20+
'dos-prompt': [
21+
('(.+)$', bygroups(using(BatchLexer)), '#pop')
22+
],
23+
}

‎_build/_themes/sphinx_rtd_theme/__init__.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
"""Sphinx ReadTheDocs theme.
2+
3+
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
4+
5+
"""
6+
from os import path
7+
8+
__version__ = '0.4.0'
9+
__version_full__ = __version__
10+
11+
12+
def get_html_theme_path():
13+
"""Return list of HTML theme paths."""
14+
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
15+
return cur_dir
16+
17+
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
18+
def setup(app):
19+
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))

‎_build/_themes/sphinx_rtd_theme/breadcrumbs.html

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
2+
3+
{% if page_source_suffix %}
4+
{% set suffix = page_source_suffix %}
5+
{% else %}
6+
{% set suffix = source_suffix %}
7+
{% endif %}
8+
9+
{% if meta is defined and meta is not none %}
10+
{% set check_meta = True %}
11+
{% else %}
12+
{% set check_meta = False %}
13+
{% endif %}
14+
15+
{% if check_meta and 'github_url' in meta %}
16+
{% set display_github = True %}
17+
{% endif %}
18+
19+
{% if check_meta and 'bitbucket_url' in meta %}
20+
{% set display_bitbucket = True %}
21+
{% endif %}
22+
23+
{% if check_meta and 'gitlab_url' in meta %}
24+
{% set display_gitlab = True %}
25+
{% endif %}
26+
27+
<div role="navigation" aria-label="breadcrumbs navigation">
28+
29+
<ul class="wy-breadcrumbs">
30+
{% block breadcrumbs %}
31+
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
32+
{% for doc in parents %}
33+
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
34+
{% endfor %}
35+
<li>{{ title }}</li>
36+
{% endblock %}
37+
{% block breadcrumbs_aside %}
38+
<li class="wy-breadcrumbs-aside">
39+
{% if hasdoc(pagename) %}
40+
{% if display_github %}
41+
{% if check_meta and 'github_url' in meta %}
42+
<!-- User defined GitHub URL -->
43+
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
44+
{% else %}
45+
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
46+
{% endif %}
47+
{% elif display_bitbucket %}
48+
{% if check_meta and 'bitbucket_url' in meta %}
49+
<!-- User defined Bitbucket URL -->
50+
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
51+
{% else %}
52+
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
53+
{% endif %}
54+
{% elif display_gitlab %}
55+
{% if check_meta and 'gitlab_url' in meta %}
56+
<!-- User defined GitLab URL -->
57+
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
58+
{% else %}
59+
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
60+
{% endif %}
61+
{% elif show_source and source_url_prefix %}
62+
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
63+
{% elif show_source and has_source and sourcename %}
64+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
65+
{% endif %}
66+
{% endif %}
67+
</li>
68+
{% endblock %}
69+
</ul>
70+
71+
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
72+
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
73+
{% if next %}
74+
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
75+
{% endif %}
76+
{% if prev %}
77+
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
78+
{% endif %}
79+
</div>
80+
{% endif %}
81+
<hr/>
82+
</div>

‎_build/_themes/sphinx_rtd_theme/footer.html

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<footer>
2+
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
3+
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
4+
{% if next %}
5+
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
6+
{% endif %}
7+
{% if prev %}
8+
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
9+
{% endif %}
10+
</div>
11+
{% endif %}
12+
13+
<hr/>
14+
15+
<div role="contentinfo">
16+
<p>
17+
{%- if show_copyright %}
18+
{%- if hasdoc('copyright') %}
19+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
20+
{%- else %}
21+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
22+
{%- endif %}
23+
{%- endif %}
24+
25+
{%- if build_id and build_url %}
26+
{% trans build_url=build_url, build_id=build_id %}
27+
<span class="build">
28+
Build
29+
<a href="{{ build_url }}">{{ build_id }}</a>.
30+
</span>
31+
{% endtrans %}
32+
{%- elif commit %}
33+
{% trans commit=commit %}
34+
<span class="commit">
35+
Revision <code>{{ commit }}</code>.
36+
</span>
37+
{% endtrans %}
38+
{%- elif last_updated %}
39+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
40+
{%- endif %}
41+
42+
</p>
43+
</div>
44+
45+
{%- if show_sphinx %}
46+
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
47+
{%- endif %}
48+
49+
{%- block extrafooter %} {% endblock %}
50+
51+
</footer>
52+

0 commit comments

Comments
 (0)