Browse Source

✏️ Tweak typos and configs (#837)

pull/856/head
Sebastián Ramírez 6 years ago
committed by GitHub
parent
commit
7b3319ddab
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 6
      README.md
  2. 2
      docs/help-fastapi.md
  3. 6
      docs/index.md
  4. 17
      mkdocs.yml
  5. 22
      pyproject.toml
  6. 2
      scripts/test.sh

6
README.md

@ -5,8 +5,8 @@
<em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em> <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
</p> </p>
<p align="center"> <p align="center">
<a href="https://travis-ci.org/tiangolo/fastapi" target="_blank"> <a href="https://travis-ci.com/tiangolo/fastapi" target="_blank">
<img src="https://travis-ci.org/tiangolo/fastapi.svg?branch=master" alt="Build Status"> <img src="https://travis-ci.com/tiangolo/fastapi.svg?branch=master" alt="Build Status">
</a> </a>
<a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank"> <a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank">
<img src="https://codecov.io/gh/tiangolo/fastapi/branch/master/graph/badge.svg" alt="Coverage"> <img src="https://codecov.io/gh/tiangolo/fastapi/branch/master/graph/badge.svg" alt="Coverage">
@ -406,7 +406,7 @@ Used by FastAPI / Starlette:
* <a href="http://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application. * <a href="http://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
You can install all of these with `pip3 install fastapi[all]`. You can install all of these with `pip install fastapi[all]`.
## License ## License

2
docs/help-fastapi.md

@ -56,7 +56,7 @@ You can:
## Tweet about **FastAPI** ## Tweet about **FastAPI**
<a href="https://twitter.com/compose/tweet?text=I'm loving FastAPI because... https://github.com/tiangolo/fastapi cc @tiangolo" target="_blank">Tweet about **FastAPI**</a> and let me and others why you like it. <a href="https://twitter.com/compose/tweet?text=I'm loving FastAPI because... https://github.com/tiangolo/fastapi cc @tiangolo" target="_blank">Tweet about **FastAPI**</a> and let me and others know why you like it.
## Let me know how are you using **FastAPI** ## Let me know how are you using **FastAPI**

6
docs/index.md

@ -5,8 +5,8 @@
<em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em> <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
</p> </p>
<p align="center"> <p align="center">
<a href="https://travis-ci.org/tiangolo/fastapi" target="_blank"> <a href="https://travis-ci.com/tiangolo/fastapi" target="_blank">
<img src="https://travis-ci.org/tiangolo/fastapi.svg?branch=master" alt="Build Status"> <img src="https://travis-ci.com/tiangolo/fastapi.svg?branch=master" alt="Build Status">
</a> </a>
<a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank"> <a href="https://codecov.io/gh/tiangolo/fastapi" target="_blank">
<img src="https://codecov.io/gh/tiangolo/fastapi/branch/master/graph/badge.svg" alt="Coverage"> <img src="https://codecov.io/gh/tiangolo/fastapi/branch/master/graph/badge.svg" alt="Coverage">
@ -406,7 +406,7 @@ Used by FastAPI / Starlette:
* <a href="http://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application. * <a href="http://www.uvicorn.org" target="_blank"><code>uvicorn</code></a> - for the server that loads and serves your application.
You can install all of these with `pip3 install fastapi[all]`. You can install all of these with `pip install fastapi[all]`.
## License ## License

17
mkdocs.yml

@ -102,6 +102,8 @@ nav:
- Release Notes: release-notes.md - Release Notes: release-notes.md
markdown_extensions: markdown_extensions:
- toc:
permalink: true
- markdown.extensions.codehilite: - markdown.extensions.codehilite:
guess_lang: false guess_lang: false
- markdown_include.include: - markdown_include.include:
@ -109,3 +111,18 @@ markdown_extensions:
- admonition - admonition
- codehilite - codehilite
- extra - extra
extra:
social:
- type: 'github'
link: 'https://github.com/tiangolo/typer'
- type: 'twitter'
link: 'https://twitter.com/tiangolo'
- type: 'linkedin'
link: 'https://www.linkedin.com/in/tiangolo'
- type: 'rss'
link: 'https://dev.to/tiangolo'
- type: 'medium'
link: 'https://medium.com/@tiangolo'
- type: 'globe'
link: 'https://tiangolo.com'

22
pyproject.toml

@ -8,17 +8,17 @@ author = "Sebastián Ramírez"
author-email = "[email protected]" author-email = "[email protected]"
home-page = "https://github.com/tiangolo/fastapi" home-page = "https://github.com/tiangolo/fastapi"
classifiers = [ classifiers = [
'Intended Audience :: Information Technology', "Intended Audience :: Information Technology",
'Intended Audience :: System Administrators', "Intended Audience :: System Administrators",
'Operating System :: OS Independent', "Operating System :: OS Independent",
'Programming Language :: Python :: 3', "Programming Language :: Python :: 3",
'Programming Language :: Python', "Programming Language :: Python",
'Topic :: Internet', "Topic :: Internet",
'Topic :: Software Development :: Libraries :: Application Frameworks', "Topic :: Software Development :: Libraries :: Application Frameworks",
'Topic :: Software Development :: Libraries :: Python Modules', "Topic :: Software Development :: Libraries :: Python Modules",
'Topic :: Software Development :: Libraries', "Topic :: Software Development :: Libraries",
'Topic :: Software Development', "Topic :: Software Development",
'Typing :: Typed', "Typing :: Typed",
"Development Status :: 4 - Beta", "Development Status :: 4 - Beta",
"Environment :: Web Environment", "Environment :: Web Environment",
"Framework :: AsyncIO", "Framework :: AsyncIO",

2
scripts/test.sh

@ -11,3 +11,5 @@ fi
export PYTHONPATH=./docs/src export PYTHONPATH=./docs/src
pytest --cov=fastapi --cov=tests --cov=docs/src --cov-report=term-missing ${@} pytest --cov=fastapi --cov=tests --cov=docs/src --cov-report=term-missing ${@}
bash ./scripts/lint.sh bash ./scripts/lint.sh
# Check README.md is up to date
diff --brief docs/index.md README.md

Loading…
Cancel
Save