kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 17:10:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
Sylius/docs
History
arti0090 9f4519a617 [DOCS] How to run async task added in installation
2022-08-21 10:09:57 +02:00
..
_exts [Docs] Allow redirecting to URLs 2020-05-11 16:16:24 +02:00
_images Add a paragraph about listing rendered events in the SF profiler 2022-07-04 12:52:10 +02: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 [DOCS] How to run async task added in installation 2022-08-21 10:09:57 +02:00
components_and_bundles Merge branch '1.10' into 1.11 2022-01-27 11:13:44 +01:00
cookbook Update .platform.app.yml for it to work 2022-05-05 22:42:29 +02:00
customization Add a paragraph about listing rendered events in the SF profiler 2022-07-04 12:52:10 +02:00
getting-started-with-sylius Removed version 2022-07-07 15:51:18 +02:00
performance Merge branch '1.10' into 1.11 2022-01-27 11:13:44 +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 favicon 2022-05-11 19:21:42 +02:00
Dockerfile Update sensio.sphinx 2020-01-20 13:07:36 +01: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 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 [Documentation] Fix build by specifying jinja2 version requirement 2022-03-30 12:54:26 +02:00

README.md

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.