Sylius/docs
mamazu ddc65335e6
Improving the documentation
* Using the correct syntax highlighting language (eg. using twig instead of html)
* Fixing the indentation of one of the curl calls
* Using the correct comments (// in yaml is not a valid comment)
2022-01-24 15:06:39 +01:00
..
_exts [Docs] Allow redirecting to URLs 2020-05-11 16:16:24 +02:00
_images Merge branch '1.10' into 1.11 2022-01-20 07:54:03 +01:00
_themes/sylius_rtd_theme [Docs] Create an unified section about all Sylius APIs 2020-05-14 11:46:45 +02:00
bdd [docs] typofixes 2021-10-04 23:09:27 +02:00
book Improving the documentation 2022-01-24 15:06:39 +01:00
components_and_bundles [DOCS]Rename promotions to cart promotion 2021-09-09 08:55:46 +02:00
cookbook Improving the documentation 2022-01-24 15:06:39 +01:00
customization Improving the documentation 2022-01-24 15:06:39 +01:00
getting-started-with-sylius Improving the documentation 2022-01-24 15:06:39 +01:00
performance Update Typo in Performance section 2021-10-21 20:14:28 +01: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 Add docs for LoyaltyRule[Api] 2021-02-03 10:26:23 +01:00
Dockerfile Update sensio.sphinx 2020-01-20 13:07:36 +01:00
index.rst Merge branch '1.9' into 1.10 2021-08-17 10:41:24 +02:00
README.md Updated Sylius description in documentation's README 2020-10-14 16:16:57 +02:00
redirection_map Merge branch '1.7' into 1.8 2020-10-19 12:43:54 +02:00
requirements.txt [Docs] Fix the build 2021-11-04 11:54:31 +01: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

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.

Authors

See the list of our amazing contributors.