Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #1387 from huge-success/docbuild

Browse Source 
Resolve build of latex documentation relating to markdown lists
This commit is contained in:
Stephen Sadowski 2018-10-30 16:13:29 -05:00 committed by GitHub
commit 7d79a86d4d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sanic/contributing.md
View File

@ -29,7 +29,7 @@ See it's that simple!
## Pull requests! ## Pull requests!
So the pull request approval rules are pretty simple: So the pull request approval rules are pretty simple:
1. All pull requests must pass unit tests * All pull requests must pass unit tests
* All pull requests must be reviewed and approved by at least * All pull requests must be reviewed and approved by at least
one current collaborator on the project one current collaborator on the project
* All pull requests must pass flake8 checks * All pull requests must pass flake8 checks

20
docs/sanic/getting_started.md
View File

@ -4,8 +4,13 @@ Make sure you have both [pip](https://pip.pypa.io/en/stable/installing/) and at
least version 3.5 of Python before starting. Sanic uses the new `async`/`await` least version 3.5 of Python before starting. Sanic uses the new `async`/`await`
syntax, so earlier versions of python won't work. syntax, so earlier versions of python won't work.
1. Install Sanic: `python3 -m pip install sanic` ## 1. Install Sanic
2. Create a file called `main.py` with the following code:
```
python3 -m pip install sanic
```
## 2. Create a file called `main.py`
```python ```python
from sanic import Sanic from sanic import Sanic
@ -21,8 +26,15 @@ syntax, so earlier versions of python won't work.
app.run(host="0.0.0.0", port=8000) app.run(host="0.0.0.0", port=8000)
``` ```
3. Run the server: `python3 main.py` ## 3. Run the server
4. Open the address `http://0.0.0.0:8000` in your web browser. You should see
```
python3 main.py
```
## 4. Check your browser
Open the address `http://0.0.0.0:8000` in your web browser. You should see
the message *Hello world!*. the message *Hello world!*.
You now have a working Sanic server! You now have a working Sanic server!