sphinx-contrib/openapi

View on GitHub

OpenAPI (fka Swagger) spec renderer for Sphinx.

Stars: 126
Forks: 88
Open beginner issues: 0
Indexed issues: 46

Dominant language: Python
License: BSD-2-Clause
Last GitHub push: Aug 17, 2026
Latest indexed: Sep 19, 2026
Contributing guide: No contributing guide
Code of conduct: No code of conduct
Beginner labels: help wanted
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

46 open issues indexed

Five open PRs, and an offer to help out Open

Difficulty 5/5 Over a week Newbie friendliness 15/100

sphinx-contrib/openapi#180 · Opened Aug 13, 2026
Old renderer with :request: crashes with KeyError: 'properties' for a non-object request body on OAS 3.0 Open

Difficulty 2/5 1-3 hours Newbie friendliness 88/100

sphinx-contrib/openapi#178 · Opened Aug 13, 2026
httpdomain renderer: block-scalar summary produces unpaired ** and literal asterisks in output Open

Difficulty 1/5 Under an hour Newbie friendliness 85/100

sphinx-contrib/openapi#173 · Opened Aug 13, 2026
Schema-derived string/enum example is emitted unencoded as an application/json body, failing the http lexer Open

Difficulty 3/5 1-2 days Newbie friendliness 68/100

sphinx-contrib/openapi#172 · 1 comment · Opened Aug 13, 2026
Old renderer with :request: emits a sourcecode block without a trailing blank line, warning under -W Open

Difficulty 1/5 Under an hour Newbie friendliness 90/100

sphinx-contrib/openapi#171 · Opened Aug 13, 2026
Datetime example field result in build fail for Sphinx Open

Difficulty 3/5 1-2 days Newbie friendliness 62/100

sphinx-contrib/openapi#168 · Opened Oct 24, 2025
ValueError: dictionary update sequence element #0 has length 1; 2 is required Open

Difficulty 2/5 1-3 hours Newbie friendliness 72/100

sphinx-contrib/openapi#166 · 1 comment · Opened May 29, 2025
Some of the new httpdomain options fail with "unknown option" error Open

Difficulty 3/5 1-2 days Newbie friendliness 50/100

sphinx-contrib/openapi#165 · Opened May 28, 2025
Unable to render examples with only readonly properties Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#160 · Opened Oct 16, 2024
Form data not accepted as POST requestBody Open

Difficulty 2/5 1-3 hours Newbie friendliness 52/100

sphinx-contrib/openapi#156 · Opened Jun 27, 2024
OpenAPI v3 cookie parameters not rendered Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#155 · Opened Jun 13, 2024
jsonschema deprecation warning Open

Difficulty 4/5 3-5 days Newbie friendliness 45/100

sphinx-contrib/openapi#154 · Opened Apr 8, 2024
Using gettext_lazy in a django-filter filterset with DRF breaks schema creation Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

sphinx-contrib/openapi#153 · Opened Apr 2, 2024
Schema examples dont show Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#152 · 2 comments · 1 reaction · Opened Mar 22, 2024
Support sphinx-autobuild Open

help wanted

Difficulty 4/5 3-5 days Newbie friendliness 30/100

sphinx-contrib/openapi#151 · Opened Mar 20, 2024
Exclude option fails when providing more than one path to exclude Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#148 · Opened Feb 5, 2024
Allow anyOf in schema Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#146 · 7 comments · Opened Dec 19, 2023
doc: request parameter is missing in the documentation Open

Difficulty 2/5 1-3 hours Newbie friendliness 55/100

sphinx-contrib/openapi#142 · 1 reaction · Opened Aug 30, 2023
Cannot build using Sphinx v4.5.0 Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

sphinx-contrib/openapi#133 · 1 comment · Opened Nov 24, 2022
Missing header descriptions in response raise exception Open

Difficulty 1/5 Under an hour Newbie friendliness 48/100

sphinx-contrib/openapi#130 · 1 comment · Opened Oct 9, 2022
Could not import extension sphinxcontrib.openapi Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

sphinx-contrib/openapi#129 · 1 comment · Opened Oct 6, 2022
Help with maintenance Open

Difficulty 3/5 1-2 days Newbie friendliness 25/100

sphinx-contrib/openapi#128 · 4 comments · 4 reactions · Opened Sep 27, 2022
Feature Request: Include / Exclude in new renderer Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

sphinx-contrib/openapi#124 · 1 reaction · Opened Apr 20, 2022
Cant' install `sphinxcontrib-openapi` with latest version of sphinx and pipenv Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

sphinx-contrib/openapi#121 · 1 comment · 4 reactions · Opened Nov 22, 2021
0.7.0: pytest warning Open

Difficulty 3/5 1-2 days Newbie friendliness 32/100

sphinx-contrib/openapi#117 · 1 comment · Opened Sep 2, 2021
0.7.0: sphinx warnings Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

sphinx-contrib/openapi#116 · 3 reactions · Opened Sep 2, 2021
`sphinx-build -W` raises an exception Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

sphinx-contrib/openapi#115 · 1 reaction · Opened Aug 23, 2021
(Question) How provide dynamic openapi file Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

sphinx-contrib/openapi#111 · Opened Jun 4, 2021
Local file references broken on windows Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#109 · Opened Apr 9, 2021
[feature request]: Filter by method for a path Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

sphinx-contrib/openapi#108 · 1 comment · 1 reaction · Opened Mar 4, 2021
Exception raised on enum query parameters without "type" Open

Difficulty 2/5 1-3 hours Newbie friendliness 62/100

sphinx-contrib/openapi#106 · 1 reaction · Opened Jan 12, 2021
An unused page "HTTP Routing Table" when generating pdf by rst2pdf Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

sphinx-contrib/openapi#105 · 1 reaction · Opened Dec 1, 2020
HTTP response codes - cannot be like '4XX', must be integer or start with an integer Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

sphinx-contrib/openapi#104 · 1 comment · Opened Nov 26, 2020
Ignore vendor extensions in new renderer Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

sphinx-contrib/openapi#103 · Opened Nov 7, 2020
Setting host for examples in openapi3 Open

Difficulty 3/5 1-2 days Newbie friendliness 38/100

sphinx-contrib/openapi#102 · 1 reaction · Opened Oct 27, 2020
Schemas are assumed to be objects, not type combinators Open

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

sphinx-contrib/openapi#96 · 4 comments · Opened Aug 10, 2020
Array of string or integer doesn't show its description Open

Difficulty 3/5 1-2 days Newbie friendliness 40/100

sphinx-contrib/openapi#93 · 1 comment · Opened Jul 22, 2020
Unexpected KeyError with simple descriptor Open

bug old-renderer

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

sphinx-contrib/openapi#92 · Opened Jun 11, 2020
Support OpenAPI v3 parameters content Open

bug old-renderer

Difficulty 3/5 1-2 days Newbie friendliness 42/100

sphinx-contrib/openapi#90 · 1 comment · Opened Jun 4, 2020
'security' block is not loaded Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

sphinx-contrib/openapi#89 · 2 comments · Opened May 29, 2020
response content schema elements missing on OpenAPI 3.0 Open

Difficulty 3/5 1-2 days Newbie friendliness 58/100

sphinx-contrib/openapi#88 · 7 comments · 2 reactions · Opened Apr 30, 2020
recursion limit exceeded (and seg faults with increased python recursion limit) Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 30/100

sphinx-contrib/openapi#86 · 5 comments · Opened Apr 9, 2020
Restructure docs to reflect recents changes in renderers Open

docs

Difficulty 3/5 1-2 days Newbie friendliness 30/100

sphinx-contrib/openapi#85 · Opened Apr 5, 2020
Parsing fails when a response includes a header without a description Open

bug

Difficulty 2/5 1-3 hours Newbie friendliness 52/100

sphinx-contrib/openapi#80 · 3 reactions · Opened Mar 25, 2020
[feature request]: table of contents of paths/methods Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

sphinx-contrib/openapi#79 · 1 reaction · Opened Mar 22, 2020
Full description of payload schema etc. Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

sphinx-contrib/openapi#14 · 2 comments · Opened May 23, 2017

sphinx-contrib/openapi

Get new issues in your inbox