Skip to content

Commit 7e72702

Browse files
author
Matthew Topol
committed
Fix readme, 'raw' directive no longer supported
1 parent 3401111 commit 7e72702

2 files changed

Lines changed: 3 additions & 10 deletions

File tree

README.rst

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,10 @@ Quart-OpenAPI
77

88
Documentation can be found on https://factset.github.io/quart-openapi/
99

10-
.. |ss| raw:: html
11-
12-
<strike>
13-
14-
.. |se| raw:: html
15-
16-
</strike>
17-
1810
.. inclusion-marker-do-not-remove
1911
2012
Quart-OpenAPI is an extension for Quart_ that adds support for generating a openapi.json file using openapi 3.0.
21-
If you are familiar with Quart_, this just wraps around it to add a openapi.json route similar to |ss| Flask-RESTPlus |se| Flask-RESTX_
13+
If you are familiar with Quart_, this just wraps around it to add a openapi.json route similar to Flask-RESTX_
2214
generating a swagger.json route and adds a Resource base class for building RESTful APIs.
2315

2416
Compatibility
@@ -92,7 +84,7 @@ Unit tests can be run through setuptools also:
9284
Request Validation
9385
==================
9486

95-
Request validation like you can get with |ss| Flask-RESTPlus |se| Flask-RESTX_!
87+
Request validation like you can get with Flask-RESTX_!
9688

9789
You can either create validator models on the fly or you can create a jsonschema document for base models
9890
and then use references to it. For an on-the-fly validator:

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ def pip(filename):
6868
version=__release__,
6969
description=__description__,
7070
long_description=long_description,
71+
long_description_content_type='text/x-rst',
7172
url='https://github.com/factset/quart-openapi',
7273
author='Matt Topol',
7374
author_email='mtopol@factset.com',

0 commit comments

Comments
 (0)