swagger-plugin-for-sphinx

Features

• The OpenAPI spec is now indexed for the sphinx search

• Add ability to mirror Swagger resources to doctree

Removals

• Removed support for sphinx 7.x

Changes

• Updated the release actions

• Add support for sphinx 9

• Removed support for sphinx 6.x
• Removed support for python 3.9

• Add support for python 3.14

• Pass the Swagger UI options also for inline rendering.

• Added missing dependency on typing-extensions

• Fixed a bug related to referencing a specification from a parent directory of the Sphinx source directory, such as when documentation is co-located with source code.

  Before this fix, when a specification was several subdirectories from the documentation, the specification could be copied to a parent directory of the build HTML output and prevent the display of the specification.

  With this fix, deeply nested specifications (../../../../openapi.yaml) have the .. values that are parents of the Sphinx source directory replaced with the text dot-dot. This fix ensures that deeply nested specifications are copied to a subdirectory of the _static directory in the HTML output.

• Refactored copying the specification to the HTML output and referencing the path to the specification in the HTML page.
• Preserves the source directory structure like docs/api/foo/openapi.yaml and docs/api/bar/openapi.yaml so that different files can use the same file name.

• Fixed an issue causing a spec to be linked incorrectly when the dirhtml builder is used.

• Fixed an issue causing a spec to be linked incorrectly when the source document is in a subfolder but the referenced spec is in another one

• Fix some errors when the spec is in a subdirectory

This release combines the previous three way into one directive streamlining the project

• Removed the swagger configuration from conf.py (however, the swagger_* configuration remain). Use the swagger-plugin directive with the full-page option to active the same
• Removed the inline-swagger directive. Use the swagger-plugin directive instead

• Add a swagger-plugin directive:

  • Automatically copy the specification YAML file to the HTML static path.
  • Insert the Swagger JavaScript and CSS tags in the <head> element of the HTML page.
  • Does not require the swagger configuration in the conf.py file.

• Add support for python 3.13
• Drop support for python 3.8

• Add support for sphinx 8

• No new features but a switch of the way this package is released

• Official support file paths for swagger_present_uri, swagger_bundle_uri and swagger_css_uri
• Remove an unnecessary download of swagger_present_uri, swagger_bundle_uri and swagger_css_uri

• Support python 3.12

• Support for inline swagger pages

• Support Sphinx 7

• Make swagger_plugin_for_sphinx.plugin private
• Remove swagger_plugin_for_sphinx.__version__
• The module can now be used as the extension name, so instead of using swagger_plugin_for_sphinx.plugin use swagger_plugin_for_sphinx

• Support sphinx 6.x
• Add official support for python 3.11
• Remove support for python 3.7
• Remove support for sphinx 4.x and 5.x

• Require at least python 3.7.2
• Support sphinx 5.x

• internal change from os.path to pathlib
• Marked the project as stable

Initial release