Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Fix Sphinx warnings & improve consistency #4919

Merged
merged 6 commits into from
May 4, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ matrix:
- memcached
-
php: 7.0
env: SYLIUS_SUITE="packages"
env: SYLIUS_SUITE="docs packages"
addons:
apt:
packages:
Expand All @@ -42,31 +42,33 @@ matrix:
cache:
directories:
- ~/.composer/cache/files
- ~/.cache/pip
- vendor
- bin
- node_modules
- docs/build
- $SYLIUS_CACHE_DIR

before_install:
- etc/travis/run-suite ${SYLIUS_SUITE} before_install
- etc/travis/run-suite before_install "${SYLIUS_SUITE}"

install:
- etc/travis/run-suite ${SYLIUS_SUITE} install
- etc/travis/run-suite install "${SYLIUS_SUITE}"

before_script:
- etc/travis/run-suite ${SYLIUS_SUITE} before_script
- etc/travis/run-suite before_script "${SYLIUS_SUITE}"

script:
- etc/travis/run-suite ${SYLIUS_SUITE} script
- etc/travis/run-suite script "${SYLIUS_SUITE}"

before_cache:
- etc/travis/run-suite ${SYLIUS_SUITE} before_cache
- etc/travis/run-suite before_cache "${SYLIUS_SUITE}"

after_success:
- etc/travis/run-suite ${SYLIUS_SUITE} after_success
- etc/travis/run-suite after_success "${SYLIUS_SUITE}"

after_failure:
- etc/travis/run-suite ${SYLIUS_SUITE} after_failure
- etc/travis/run-suite after_failure "${SYLIUS_SUITE}"

after_script:
- etc/travis/run-suite ${SYLIUS_SUITE} after_script
- etc/travis/run-suite after_script "${SYLIUS_SUITE}"
20 changes: 10 additions & 10 deletions docs/api/authorization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ Example Response
.. code-block:: json

{
access_token: "NzFiYTM4ZTEwMjcwZTcyZWIzZTA0NmY3NjE3MTIyMjM1Y2NlMmNlNWEyMTAzY2UzYmY0YWIxYmUzNTkyMDcyNQ"
expires_in: 3600
token_type: "bearer"
scope: null
refresh_token: "MDk2ZmIwODBkYmE3YjNjZWQ4ZTk2NTk2N2JmNjkyZDQ4NzA3YzhiZDQzMjJjODI5MmQ4ZmYxZjlkZmU1ZDNkMQ"
"access_token": "NzFiYTM4ZTEwMjcwZTcyZWIzZTA0NmY3NjE3MTIyMjM1Y2NlMmNlNWEyMTAzY2UzYmY0YWIxYmUzNTkyMDcyNQ",
"expires_in": 3600,
"token_type": "bearer",
"scope": null,
"refresh_token": "MDk2ZmIwODBkYmE3YjNjZWQ4ZTk2NTk2N2JmNjkyZDQ4NzA3YzhiZDQzMjJjODI5MmQ4ZmYxZjlkZmU1ZDNkMQ"
}

Request for resource
Expand Down Expand Up @@ -170,9 +170,9 @@ You can now use new token to send requests
.. code-block:: json

{
access_token: "MWExMWM0NzE1NmUyZDgyZDJiMjEzMmFlMjQ4MzgwMmE4ZTkxYzM0YjdlN2U2YzliNDIyMTk1ZDhlNDYxYWE4Ng"
expires_in: 3600
token_type: "bearer"
scope: null
refresh_token: "MWI4NzVkNThjZDc2Y2M1N2JiNzBmOTQ0MDFmY2U0YzVjYzllMDE1OTU5OWFiMzJiZTY5NGU4NzYyODU1N2ZjYQ"
"access_token": "MWExMWM0NzE1NmUyZDgyZDJiMjEzMmFlMjQ4MzgwMmE4ZTkxYzM0YjdlN2U2YzliNDIyMTk1ZDhlNDYxYWE4Ng",
"expires_in": 3600,
"token_type": "bearer",
"scope": null,
"refresh_token": "MWI4NzVkNThjZDc2Y2M1N2JiNzBmOTQ0MDFmY2U0YzVjYzllMDE1OTU5OWFiMzJiZTY5NGU4NzYyODU1N2ZjYQ"
}
6 changes: 3 additions & 3 deletions docs/api/channels.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Channels API
=========
============

Sylius channels API endpoint is ``/api/channels``.

Expand Down Expand Up @@ -111,8 +111,8 @@ Response
"updated_at": "2014-11-26T23:00:15+0000"
}

Create an channel
---------------
Creating a channel
------------------

To create a new channel, you can execute the following request:

Expand Down
6 changes: 3 additions & 3 deletions docs/api/payments.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Payments API
==========
============

Sylius payment API endpoint is `/api/payments`.

Expand Down Expand Up @@ -66,7 +66,7 @@ Response
}

Getting a single payment
-------------------------
------------------------

You can view a single payment by executing the following request:

Expand All @@ -86,7 +86,7 @@ Response
{"to": "do"}

Deleting a payment
-------------------
------------------

You can delete a payment from the system by making the following DELETE call:

Expand Down
6 changes: 3 additions & 3 deletions docs/api/products.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Products API
============

Sylius products catalogue API endpoint is `/api/products` and it allows for browsing, creating & editing product information.
Sylius products catalogue API endpoint is ``/api/products`` and it allows for browsing, creating & editing product information.

Index of all products
---------------------
Expand Down Expand Up @@ -113,8 +113,8 @@ Response
"updated_at": "2014-11-26T23:00:20+0000"
}

Create an product
---------------
Creating an product
-------------------

To create a new product, you can execute the following request:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/promotions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Response
}

Deleting a promotion
-------------------
--------------------

You can delete a promotion from the system by making the following DELETE call:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/shipments.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Shipments API
==========
=============

Sylius shipments API endpoint is `/api/shipments`.

Expand Down
4 changes: 2 additions & 2 deletions docs/book/emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ E-Mails
=======

Sylius is sending various e-mails and this chapter is a reference about all of them. Continue reading to learn what e-mails are sent, when and how to customize the templates.
To understand how e-mail sending works internally, please refer to :doc:`SyliusMailerBundle documentation </bundles/SyliusMailerMailer/index>`.
To understand how e-mail sending works internally, please refer to :doc:`SyliusMailerBundle documentation </bundles/SyliusMailerBundle/index>`.

User Confirmation E-Mail
------------------------

Every time new customer registers via registration form or checkout, ``user_confirmation`` e-mail is sent to him.
The default template is

.. code-block:: test
.. code-block:: text

SyliusWebBundle:Email:userConfirmation.html.twig

Expand Down
2 changes: 1 addition & 1 deletion docs/bundles/SyliusAddressingBundle/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ You'll get familiar with it in later parts of this documentation.
installation
zones
forms
Summary
summary
4 changes: 2 additions & 2 deletions docs/bundles/SyliusAddressingBundle/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ If you have `Composer installed globally <http://getcomposer.org/doc/00-intro.md

.. code-block:: bash

$ composer require sylius/addressing-bundle:*
$ composer require sylius/addressing-bundle

Otherwise you have to download .phar file.

Expand Down Expand Up @@ -87,7 +87,7 @@ Import the routing configuration by adding the following to your ``app/config/ro
.. code-block:: yaml

sylius_addressing:
resource: @SyliusAddressingBundle/Resources/config/routing.yml
resource: "@SyliusAddressingBundle/Resources/config/routing.yml"

Updating database schema
------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/bundles/SyliusAddressingBundle/summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,11 @@ Tests

.. code-block:: bash

$ composer install --dev --prefer-dist
$ composer install
$ bin/phpspec run -fpretty --verbose

Bug tracking
------------

This bundle uses `GitHub issues <https://github.com/Sylius/Sylius/issues>`_.
If you have found bug, please create an issue.
If you have found bug, please create an issue.
4 changes: 2 additions & 2 deletions docs/bundles/SyliusArchetypeBundle/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ If you have `Composer installed globally <http://getcomposer.org/doc/00-intro.md

.. code-block:: bash

$ composer require "sylius/archetype-bundle"
$ composer require sylius/archetype-bundle

Otherwise you have to download .phar file.

.. code-block:: bash

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require "sylius/archetype-bundle"
$ php composer.phar require sylius/archetype-bundle

Adding required bundles to the kernel
-------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/bundles/SyliusAttributeBundle/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ If you have `Composer installed globally <http://getcomposer.org/doc/00-intro.md

.. code-block:: bash

$ composer require "sylius/attribute-bundle"
$ composer require sylius/attribute-bundle

Otherwise you have to download .phar file.

.. code-block:: bash

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require "sylius/attribute-bundle"
$ php composer.phar require sylius/attribute-bundle

Adding required bundles to the kernel
-------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/bundles/SyliusCartBundle/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ If you have `Composer installed globally <http://getcomposer.org/doc/00-intro.md

.. code-block:: bash

$ composer require "sylius/cart-bundle"
$ composer require sylius/cart-bundle

Otherwise you have to download .phar file.

.. code-block:: bash

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require "sylius/cart-bundle"
$ php composer.phar require sylius/cart-bundle

Adding required bundles to the kernel
-------------------------------------
Expand Down Expand Up @@ -339,7 +339,7 @@ Import the default routing from your ``app/config/routing.yml``.
.. code-block:: yaml

sylius_cart:
resource: @SyliusCartBundle/Resources/config/routing.yml
resource: "@SyliusCartBundle/Resources/config/routing.yml"
prefix: /cart

Updating database schema
Expand Down
2 changes: 1 addition & 1 deletion docs/bundles/SyliusCartBundle/summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Configuration reference

.. code-block:: bash

$ composer install --dev --prefer-dist
$ composer install
$ bin/phpspec run -f pretty


Expand Down
5 changes: 2 additions & 3 deletions docs/bundles/SyliusContactBundle/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
SyliusContactBundle
================
===================

A generic solution for a contact form inside a Symfony2 application.

There are two main models inside the bundle, `ContactRequest` and `ContactTopic`.
There are two main models inside the bundle, ``ContactRequest`` and ``ContactTopic``.

.. toctree::
:numbered:

models
configuration
12 changes: 0 additions & 12 deletions docs/bundles/SyliusContactBundle/models.rst

This file was deleted.

6 changes: 3 additions & 3 deletions docs/bundles/SyliusFlowBundle/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ If you have `Composer installed globally <http://getcomposer.org/doc/00-intro.md

.. code-block:: bash

$ composer require "sylius/flow-bundle"
$ composer require sylius/flow-bundle

Otherwise you have to download .phar file.

.. code-block:: bash

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require "sylius/flow-bundle"
$ php composer.phar require sylius/flow-bundle

Adding required bundles to the kernel
-------------------------------------
Expand Down Expand Up @@ -152,7 +152,7 @@ Import routing configuration:
.. code-block:: yaml

acme_flow:
resource: @SyliusFlowBundle/Resources/config/routing.yml
resource: "@SyliusFlowBundle/Resources/config/routing.yml"
prefix: /flow

If you take a look into imported routing configuration, you will see that ``sylius_flow_start`` is a wizard entry point.
Expand Down
2 changes: 1 addition & 1 deletion docs/bundles/SyliusFlowBundle/summary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Tests

.. code-block:: bash

$ composer install --dev --prefer-dist
$ composer install
$ phpunit

Working examples
Expand Down
2 changes: 1 addition & 1 deletion docs/bundles/SyliusGridBundle/custom_column_type.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ Now you can use your new column type in the grid configuration!
monitor:
type: tournament_monitor
options:
dynamic: %kernel.debug%
dynamic: "%kernel.debug%"
2 changes: 1 addition & 1 deletion docs/bundles/SyliusGridBundle/filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ multiple (Default: false)
multiple: true

Currency (*currency*)
-------------------
---------------------

This filter allows the user to select one or multiple currencies.

Expand Down
4 changes: 2 additions & 2 deletions docs/bundles/SyliusGridBundle/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ If you have `Composer installed globally <http://getcomposer.org/doc/00-intro.md

.. code-block:: bash

$ composer require sylius/grid-bundle:v0.15.0
$ composer require sylius/grid-bundle

Otherwise you have to download .phar file.

.. code-block:: bash

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require sylius/grid-bundle:v0.15.0
$ php composer.phar require sylius/grid-bundle

Adding required bundles to the kernel
-------------------------------------
Expand Down
Loading