Merge pull request #115 from collective/rtd-build

Build docs PR preview on RTD

Author: datakurre

.gitignore

@@ -4,15 +4,8 @@
 .cache
 .coverage
 .devenv*
-.eggs/
-.idea/
-.installed.cfg
 .pre-commit-config.yaml
-.pytest_cache/
-bin/
-devenv.local.nix
-docs/_build/
-html/
-htmlcov/
-result
+.eggs/
+_build/
 coverage.xml
+devenv.local.nix

CHANGELOG.md

@@ -2,8 +2,21 @@
 
 ## 2.0rc2 (unreleased)
 
-
-- Nothing changed yet.
+- Dropped support for Python 3.9.
+  [stevepiercy]
+- Migrated from `pkg_resources` to `importlib`.
+  [datakurre]
+- Overhauled `Makefile`. Add `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]
 
 
 ## 2.0rc1 (2025-12-02)
@@ -22,70 +35,70 @@
 
 ## 1.2 (2024-08-17)
 
-- Add new HTTP example builder `plone-javascript`  
+- Add new HTTP example builder `plone-javascript`
   [datakurre]
-- Fix tabbing to no longer depend on jQuery  
+- Fix tabbing to no longer depend on jQuery
   [datakurre]
-- Fix tabbing to support arrow key navigation  
+- Fix tabbing to support arrow key navigation
   [datakurre]
-- Fix tab key to stop at tab list only once  
+- Fix tab key to stop at tab list only once
   [datakurre]
-- Fix requests builder to flatten simple values in form data  
+- Fix requests builder to flatten simple values in form data
   [datakurre]
-- Fix requests builder to pass form data as dictionary  
+- Fix requests builder to pass form data as dictionary
   [datakurre]
-- Change JavaScript-based tabbing to no longer require JQuery  
+- Change JavaScript-based tabbing to no longer require JQuery
   [datakurre]
 
 ## 1.1 (2021-12-25)
 
-- Add support for docutils 0.17.x  
+- Add support for docutils 0.17.x
   [kvondersaar, datakurre]
-- Add support for Python 3.8  
+- Add support for Python 3.8
   [datakurre]
-- Fix example tabs accessibility  
+- Fix example tabs accessibility
   [datakurre]
 
 ## 1.0 (2021-09-10)
 
-- The curl command builder will now always specify a method  
+- The curl command builder will now always specify a method
   [LefterisJP]
 
 ## 0.11.0 (2021-05-14)
 
-- Change to quote examples with `"` rather than `'`  
+- Change to quote examples with `"` rather than `'`
   [datakurre]
-- Fix Sphinx deprecation warnings and support Sphinx 4.x  
+- Fix Sphinx deprecation warnings and support Sphinx 4.x
   [kkrypt0nn, AWhetter]
-- Fix to use `ast.unparse` instead of `astunparse` on Python >= 3.9  
+- Fix to use `ast.unparse` instead of `astunparse` on Python >= 3.9
   [datakurre]
 
 ## 0.10.3 (2019-05-01)
 
-- Re-release 0.10.2 with wheel  
+- Re-release 0.10.2 with wheel
   [datakurre]
 
 ## 0.10.2 (2019-05-01)
 
-- Add support for inline response examples without HTTP version  
-  (e.g., `HTTP 200 OK`)  
+- Add support for inline response examples without HTTP version
+  (e.g., `HTTP 200 OK`)
   [datakurre]
-- Fix regression where support for reading request examples from  
-  external files was broken since 0.10.0  
+- Fix regression where support for reading request examples from
+  external files was broken since 0.10.0
   [datakurre]
 
 ## 0.10.1 (2019-03-19)
 
-- Fix issue where it was not possible to request examples with  
-  float values in payload JSON [fixes #42]  
+- Fix issue where it was not possible to request examples with
+  float values in payload JSON [fixes #42]
   [datakurre]
 
 ## 0.10.0 (2018-10-09)
 
-- Add support for URL query parameters, using the `query` field.  
-  Given a line `:query param_name: param_value` in an HTTP example  
-  directive, the key-value pair `param_name`, `param_value` will be  
-  added to the request URL (and excluded from further processing).  
+- Add support for URL query parameters, using the `query` field.
+  Given a line `:query param_name: param_value` in an HTTP example
+  directive, the key-value pair `param_name`, `param_value` will be
+  added to the request URL (and excluded from further processing).
   [ludaavics]
 
   Example:
@@ -105,107 +118,107 @@
 
 ## 0.9.1 (2018-10-06)
 
-- Fix packaging to include `setup.cfg` in sdist  
+- Fix packaging to include `setup.cfg` in sdist
   [datakurre]
-- Add the Guillotina docs (which now uses httpexample)  
+- Add the Guillotina docs (which now uses httpexample)
   [cdevienne]
 
 ## 0.9.0 (2018-07-22)
 
-- Add support for inlining responses  
+- Add support for inlining responses
   [cdevienne]
 
 ## 0.8.1 (2018-06-27)
 
-- Fix error when parsing top-level JSON lists  
+- Fix error when parsing top-level JSON lists
   [AWhetter]
 
 ## 0.8.0 (2017-11-18)
 
-- Fix to not strip out `Accept`/`Content-Type` headers in builders  
+- Fix to not strip out `Accept`/`Content-Type` headers in builders
   [dokai]
-- Improve logic to detect a JSON content type  
+- Improve logic to detect a JSON content type
   [dokai]
-- Use redirected input to pass request payload to `httpie`  
+- Use redirected input to pass request payload to `httpie`
   [dokai]
-- Fix quoting of non-trivial HTTP headers in builders  
+- Fix quoting of non-trivial HTTP headers in builders
   [dokai]
-- Change to use declarative packaging (`setup.cfg` instead of `setup.py`)  
+- Change to use declarative packaging (`setup.cfg` instead of `setup.py`)
   [datakurre]
 
 ## 0.7.0 (2017-10-21)
 
-- Allow the URL scheme (`http` or `https`) to be configured  
+- Allow the URL scheme (`http` or `https`) to be configured
   [dokai]
-- Quote the URL if it contains `&` characters in `curl`/`httpie`/`wget` examples  
+- Quote the URL if it contains `&` characters in `curl`/`httpie`/`wget` examples
   [dokai]
 
 ## 0.6.1 (2017-05-11)
 
-- Release as universal wheel  
+- Release as universal wheel
   [datakurre]
 
 ## 0.6.0 (2017-05-11)
 
-- Support non-JSON requests  
+- Support non-JSON requests
   [jaroel]
-- Support `application/json; charset=utf-8`  
+- Support `application/json; charset=utf-8`
   [skyzyx]
 
 ## 0.5.2 (2017-03-09)
 
-- Fix packaging to include the files in `static` [#3]  
+- Fix packaging to include the files in `static` [#3]
   [csenger]
 
 ## 0.5.1 (2017-03-05)
 
-- Update README and documentation  
+- Update README and documentation
   [datakurre]
 
 ## 0.5.0 (2017-03-05)
 
-- Change development status to beta  
+- Change development status to beta
   [datakurre]
 
 ## 0.4.2 (2017-03-05)
 
-- Fix issue where `wget` basic auth required a challenge from the backend, which is not  
-  always available  
+- Fix issue where `wget` basic auth required a challenge from the backend, which is not
+  always available
   [datakurre]
 
 ## 0.4.1 (2017-03-05)
 
-- Fix issue where generated `httpie` commands did not always set `Accept` and  
-  `Content-Type` headers  
+- Fix issue where generated `httpie` commands did not always set `Accept` and
+  `Content-Type` headers
   [datakurre]
 
 ## 0.4.0 (2017-03-05)
 
-- Add support for `wget`  
+- Add support for `wget`
   [datakurre]
 
 ## 0.3.0 (2017-03-05)
 
-- Add generic `Authorization` header support  
+- Add generic `Authorization` header support
   [datakurre]
 
 ## 0.2.1 (2017-03-05)
 
-- Fix issue where `Authorization` header was always required  
+- Fix issue where `Authorization` header was always required
   [datakurre]
-- Fix to raise proper exception when parsing bad requests  
+- Fix to raise proper exception when parsing bad requests
   [datakurre]
-- Fix issue where `httpie` builder did not quote values with spaces  
+- Fix issue where `httpie` builder did not quote values with spaces
   [datakurre]
-- Fix link to `python-requests` documentation  
+- Fix link to `python-requests` documentation
   [datakurre]
 
 ## 0.2.0 (2017-03-05)
 
-- Add support for `GET` requests  
+- Add support for `GET` requests
   [datakurre]
 
 ## 0.1.0 (2017-03-05)
 
-- First release  
+- First release
   [datakurre]