From 7b3319ddabad1006468db7a7b864660b163718a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Wed, 8 Jan 2020 23:25:29 +0100 Subject: [PATCH] :pencil2: Tweak typos and configs (#837) --- .travis.yml | 10 +++++----- README.md | 6 +++--- docs/help-fastapi.md | 2 +- docs/index.md | 6 +++--- mkdocs.yml | 35 ++++++++++++++++++++++++++--------- pyproject.toml | 22 +++++++++++----------- scripts/test.sh | 2 ++ 7 files changed, 51 insertions(+), 32 deletions(-) diff --git a/.travis.yml b/.travis.yml index 22e60e374..5bc279c31 100644 --- 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 4f73c0f71..cf94ea3ba 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ FastAPI framework, high performance, easy to learn, fast to code, ready for production

- - Build Status + + Build Status Coverage @@ -406,7 +406,7 @@ Used by FastAPI / Starlette: * uvicorn - 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 1c8f7310d..f029d0aa3 100644 --- a/docs/help-fastapi.md +++ b/docs/help-fastapi.md @@ -56,7 +56,7 @@ You can: ## Tweet about **FastAPI** -Tweet about **FastAPI** and let me and others why you like it. +Tweet about **FastAPI** 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 4f73c0f71..cf94ea3ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,8 +5,8 @@ FastAPI framework, high performance, easy to learn, fast to code, ready for production

- - Build Status + + Build Status Coverage @@ -406,7 +406,7 @@ Used by FastAPI / Starlette: * uvicorn - 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 1bb9dc08f..270a73d0d 100644 --- 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 2bba24ca2..92a288d4a 100644 --- 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 6e08f1877..e61c8e3b6 100755 --- 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