:pencil2: Tweak typos and configs (#837)

diff --git a/.travis.yml b/.travis.yml
index 22e60e374f107ffad63edc0ba1d1a912305f4ff6..5bc279c31ca4388ce05afd3a416f99c57dbe6ad3 100644 (file)
--- a/.travis.yml
+++ b/.travis.yml
@@ -25,8 +25,8 @@ after_script:
     - bash <(curl -s https://codecov.io/bash)
 
 deploy:
-  provider: script
-  script: bash scripts/deploy.sh
-  on:
-    tags: true
-    python: "3.6"
+    provider: script
+    script: bash scripts/deploy.sh
+    on:
+        tags: true
+        python: "3.6"

diff --git a/README.md b/README.md
index 4f73c0f71466fd09127a31aabbf240955f00afd2..cf94ea3ba6cee49701ec2af1eb2c9e50821ca22b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,8 +5,8 @@
     <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
 </p>
 <p align="center">
-<a href="https://travis-ci.org/tiangolo/fastapi" target="_blank">
-    <img src="https://travis-ci.org/tiangolo/fastapi.svg?branch=master" alt="Build Status">
+<a href="https://travis-ci.com/tiangolo/fastapi" target="_blank">
+    <img src="https://travis-ci.com/tiangolo/fastapi.svg?branch=master" alt="Build Status">
 </a>
 <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">
@@ -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.
 
-You can install all of these with `pip3 install fastapi[all]`.
+You can install all of these with `pip install fastapi[all]`.
 
 ## License
 

diff --git a/docs/help-fastapi.md b/docs/help-fastapi.md
index 1c8f7310d73990a04d3a09b473344d1b9cfb649b..f029d0aa39f6db4c995028124d8217a56d19eb3a 100644 (file)
--- a/docs/help-fastapi.md
+++ b/docs/help-fastapi.md
@@ -56,7 +56,7 @@ You can:
 
 ## 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**
 

diff --git a/docs/index.md b/docs/index.md
index 4f73c0f71466fd09127a31aabbf240955f00afd2..cf94ea3ba6cee49701ec2af1eb2c9e50821ca22b 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -5,8 +5,8 @@
     <em>FastAPI framework, high performance, easy to learn, fast to code, ready for production</em>
 </p>
 <p align="center">
-<a href="https://travis-ci.org/tiangolo/fastapi" target="_blank">
-    <img src="https://travis-ci.org/tiangolo/fastapi.svg?branch=master" alt="Build Status">
+<a href="https://travis-ci.com/tiangolo/fastapi" target="_blank">
+    <img src="https://travis-ci.com/tiangolo/fastapi.svg?branch=master" alt="Build Status">
 </a>
 <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">
@@ -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.
 
-You can install all of these with `pip3 install fastapi[all]`.
+You can install all of these with `pip install fastapi[all]`.
 
 ## License
 

diff --git a/mkdocs.yml b/mkdocs.yml
index 1bb9dc08f2a729cca4ff437ad2e05494e4a76b05..270a73d0dc3651d70e7daeedd4644e6542fcce70 100644 (file)
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -5,8 +5,8 @@ site_url: https://fastapi.tiangolo.com/
 theme:
     name: 'material'
     palette:
-      primary: 'teal'
-      accent: 'amber'
+        primary: 'teal'
+        accent: 'amber'
     logo: 'img/icon-white.svg'
     favicon: 'img/favicon.png'
 
@@ -102,10 +102,27 @@ nav:
     - Release Notes: release-notes.md
 
 markdown_extensions:
-  - markdown.extensions.codehilite:
-      guess_lang: false
-  - markdown_include.include:
-      base_path: docs
-  - admonition
-  - codehilite
-  - extra
+    - toc:
+        permalink: true
+    - markdown.extensions.codehilite:
+        guess_lang: false
+    - markdown_include.include:
+        base_path: docs
+    - admonition
+    - codehilite
+    - 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'

diff --git a/pyproject.toml b/pyproject.toml
index 2bba24ca215e3c9bdabaf2e4a35f9fddc8e3a944..92a288d4a9be964898f5ed5637eb7f40ff0d0051 100644 (file)
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -8,17 +8,17 @@ author = "Sebastián Ramírez"
 author-email = "tiangolo@gmail.com"
 home-page = "https://github.com/tiangolo/fastapi"
 classifiers = [
-    'Intended Audience :: Information Technology',
-    'Intended Audience :: System Administrators',
-    'Operating System :: OS Independent',
-    'Programming Language :: Python :: 3',
-    'Programming Language :: Python',
-    'Topic :: Internet',
-    'Topic :: Software Development :: Libraries :: Application Frameworks',
-    'Topic :: Software Development :: Libraries :: Python Modules',
-    'Topic :: Software Development :: Libraries',
-    'Topic :: Software Development',
-    'Typing :: Typed',
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "Typing :: Typed",
     "Development Status :: 4 - Beta",
     "Environment :: Web Environment",
     "Framework :: AsyncIO",

diff --git a/scripts/test.sh b/scripts/test.sh
index 6e08f187702368452a5a7e8e9d423821e64b58ea..e61c8e3b63a4742c60e910e081a71d7ab1913b1c 100755 (executable)
--- a/scripts/test.sh
+++ b/scripts/test.sh
@@ -11,3 +11,5 @@ fi
 export PYTHONPATH=./docs/src
 pytest --cov=fastapi --cov=tests --cov=docs/src --cov-report=term-missing ${@}
 bash ./scripts/lint.sh
+# Check README.md is up to date
+diff --brief docs/index.md README.md