mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-14 09:02:12 +00:00
e06428cce2
| Q | A |-----------------|----- | Branch? | 2.0 | Bug fix? | no | New feature? | no | BC breaks? | yes | Deprecations? | no | Related tickets | n/a | License | MIT <!-- - Bug fixes must be submitted against the 1.13 branch - Features and deprecations must be submitted against the 1.14 branch - Features, removing deprecations and BC breaks must be submitted against the 2.0 branch - Make sure that the correct base branch is set To be sure you are not breaking any Backward Compatibilities, check the documentation: https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html --> |
||
|---|---|---|
| .. | ||
| _exts | ||
| _images | ||
| _themes/sylius_rtd_theme | ||
| bdd | ||
| book | ||
| components_and_bundles | ||
| cookbook | ||
| customization | ||
| getting-started-with-sylius | ||
| performance | ||
| .dockerignore | ||
| .gitignore | ||
| build.sh | ||
| conf.py | ||
| docker-compose.yml | ||
| Dockerfile | ||
| favicon.ico | ||
| index.rst | ||
| README.md | ||
| redirection_map | ||
| requirements.txt | ||
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:
-
Download the documentation requirements:
pip install -r requirements.txtThis makes sure that the version of Sphinx you'll get is >=1.4.2!
-
Install Sphinx
pip install Sphinx -
In the
docsdirectory runsphinx-build -b html . buildand view the generated HTML files in thebuilddirectory.
Docker
Execute Docker Compose command and enter localhost
docker compose up -d
open localhost
Authors
See the list of our amazing contributors.