README (1599B)
1 Bundled copy of sphinxcontrib-httpdomain 2 ======================================== 3 4 Upstream: https://github.com/sphinx-contrib/httpdomain 5 Version: 2.2.1 (PyPI "sphinxcontrib-httpdomain", released 2026-10-14) 6 License: BSD-2-Clause, see LICENSE 7 Requires: Sphinx 8.1.3 or later, Python 3.10 or later (upstream's 8 requirements) 9 10 conf.py loads it as the extension "httpdomain"; it is found through the 11 _exts/ entry that conf.py adds to sys.path. The handbook uses it in 12 developers/rest-api/namestore.rst. 13 14 Files 15 ----- 16 17 __init__.py, _path_signature.py and websocket.py are copied unchanged 18 from the package sphinxcontrib/httpdomain/ in the upstream wheel, except 19 for the local change below. 20 21 Not included: 22 23 - sphinxcontrib/autohttp/ (autoflask, autobottle, autotornado): not used 24 by the handbook, and it needs Flask, Bottle or Tornado. 25 - sphinxcontrib/httpdomain/locale/: the Spanish and French translations 26 of the extension's own labels. The handbook is in English. 27 28 Local changes 29 ------------- 30 31 Re-apply these when updating: 32 33 - __init__.py: HTTPDomain.indices is [] instead of [HTTPIndex], so that 34 no "HTTP Routing Table" page (http-routingtable.html) is generated. 35 The previously bundled version 1.7.0 had the same change. 36 37 Updating 38 -------- 39 40 pip download --no-deps sphinxcontrib-httpdomain==VERSION 41 unzip sphinxcontrib_httpdomain-VERSION-*.whl 42 43 Copy the three files listed above from sphinxcontrib/httpdomain/ and 44 LICENSE from the .dist-info directory, re-apply the local changes, update 45 the version in this file, and check how developers/rest-api/namestore.rst 46 renders.