kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 09:02:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[Docs] Update build instructions

Browse source
This commit is contained in:
Kamil Kokot 2016-05-06 12:47:09 +02:00
parent 4858e27cd3
commit 48f996cb76
No known key found for this signature in database
GPG key ID: 7BD76F7054D93C89
1 changed files with 3 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/README.md
View file

@ -21,15 +21,9 @@ Build
If you contribute to documentation you will want to check how it looks after your changes. If you contribute to documentation you will want to check how it looks after your changes.
To be able to build the documentation, install [Sphinx](http://sphinx-doc.org/). To be able to build the documentation, install [Sphinx](http://sphinx-doc.org/).
``` 1. [Install `pip`, Python package manager](https://pip.pypa.io/en/stable/installing/)
$ sudo easy_install -U Sphinx 2. Download documentation requirements: `$ pip install -r requirements.txt`
``` 3. Build the documentation:`$ sphinx-build -b html . build`
Then run the following command.
```
$ sphinx-build -b html . build
```
Documentation index is `build/index.html`. Documentation index is `build/index.html`.