Sphinxcontrib-httpexample 2.0 released

Documentation
, ,
1

sphinxcontrib-httpexample 2.0 has been released.

sphinxcontrib-httpexample is a Sphinx domain extension for describing RESTful HTTP APIs in detail. It enhances sphinxcontrib-httpdomain with a simple call example directive. The directive provided by this extension generates RESTful HTTP API call examples for different HTTP clients from a single HTTP request example.

The audience for this extension are developers and technical writers documenting their RESTful HTTP APIs. This extension was originally developed for documenting plone.restapi.

@datakurre maintains and releases this Sphinx extension. @stevepiercy and @Hrittik20 made significant contributions to this release.

What's Changed

  • Dropped support for Python 3.9. [datakurre, stevepiercy]
  • Migrated from pkg_resources to importlib. [datakurre]
  • Overhauled Makefile. Added make lint and make test targets. [stevepiercy]
  • Use uv to set up a development environment. [stevepiercy]
  • Enhanced documentation with @plone/client examples, clarify headings, fix broken links, and improve formatting, grammar, and syntax. Added sphinx-copybutton extension to allow copying code snippets. [stevepiercy]
  • Use the name argument for the CSS label. [Hrittik20]
  • Fixed a regression so that the response tab now shows the HTTP response instead of the request. [datakurre]

Read the complete change log at sphinxcontrib-httpexample/CHANGELOG.md at master · collective/sphinxcontrib-httpexample · GitHub.

Download

Issues

Contribute

6 Likes