mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-05 20:57:12 +00:00
29d2b89362
This PR has been generated automatically. For more details see [upmerge_pr.yaml](/Sylius/Sylius/blob/1.13/.github/workflows/upmerge_pr.yaml). **Remember!** The upmerge should always be merged with using `Merge pull request` button. In case of conflicts, please resolve them manually with usign the following commands: ``` git fetch upstream gh pr checkout <this-pr-number> git merge upstream/1.13 -m "Resolve conflicts between 1.12 and 1.13" ``` If you use other name for the upstream remote, please replace `upstream` with the name of your remote pointing to the `Sylius/Sylius` repository. Once the conflicts are resolved, please run `git merge --continue` and push the changes to this PR. |
||
|---|---|---|
| .. | ||
| _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.