Sylius/docs
Grzegorz Sadowski 89c8bb6018
Merge branch '1.12' into 1.13
* 1.12:
  Fix url in links
  Remove possibility to add Stripe as a payment method when package is missing
2023-02-14 15:30:53 +01:00
..
_exts Update versions in the "Submitting a Patch" doc 2023-02-08 14:35:14 +01:00
_images Merge branch '1.11' into 1.12 2022-12-09 11:57:38 +01:00
_themes/sylius_rtd_theme [DOCS] Change the github link on search page 2022-05-30 08:44:14 +02:00
bdd Fixing the documentation (1.10) 2022-01-26 23:48:27 +01:00
book Update Plus' dependencies' versions requirements 2023-02-09 10:00:20 +01:00
components_and_bundles Merge branch '1.12' into 1.13 2023-02-03 14:44:16 +01:00
cookbook Merge branch '1.12' into 1.13 2023-02-10 08:50:06 +01:00
customization docs #13440 Add documentation for non-labeled actions (loic425) 2023-02-03 15:41:29 +01:00
getting-started-with-sylius Fix url in links 2023-02-14 11:21:34 +01:00
performance Merge branch '1.10' into 1.11 2022-01-27 11:13:44 +01:00
.dockerignore [docker][docs]Create Docker Compose configuration file for documentation 2022-06-08 17:47:47 +02:00
.gitignore Update sensio.sphinx 2020-01-20 13:07:36 +01:00
build.sh [CI] Switch documentation build from Travis to GitHub Actions 2020-11-25 14:41:53 +01:00
conf.py Update versions in the "Submitting a Patch" doc 2023-02-08 14:35:14 +01:00
docker-compose.yml [docs][docker]Auto build after each change 2022-08-22 18:29:52 +02:00
Dockerfile [docker][docs]Create Docker Compose configuration file for documentation 2022-06-08 17:47:47 +02:00
favicon.ico favicon 2022-05-11 19:21:42 +02:00
index.rst [DOCS] Update Index Tip section 2022-04-07 19:21:58 +02:00
README.md [docker][docs]Create Docker Compose configuration file for documentation 2022-06-08 17:47:47 +02:00
redirection_map Remove migrating to webpack page from docs 2022-09-21 12:38:19 +02:00
requirements.txt [docs][docker]Auto build after each change 2022-08-22 18:29:52 +02:00

Sylius Documentation

This directory contains documentation for Sylius - Open Source eCommerce platform on top of Symfony, available on docs.sylius.com.

It is hosted by the great readthedocs.org.

Sylius on Twitter

If you want to keep up with all the updates, follow the official Sylius account on twitter.

Issues

The documentation uses GitHub issues.

Build

Traditional

To test the documentation before a commit:

  • Install pip, Python package manager

  • Download the documentation requirements:

    pip install -r requirements.txt

    This makes sure that the version of Sphinx you'll get is >=1.4.2!

  • Install Sphinx

    pip install Sphinx

  • In the docs directory run sphinx-build -b html . build and view the generated HTML files in the build directory.

Docker

Execute Docker Compose command and enter localhost

docker compose up -d
open localhost

Authors

See the list of our amazing contributors.