Add a Sphinx extension for enhanced JSON writing.

Review Request #13099 — Created June 5, 2023 and submitted

Information

beanbag-docutils
master

Reviewers

This augments the JSONHTMLWriter found in
sphinxcontrib-serializinghtml (or native to Sphinx in the
old-but-still-supported 1.8) to include two new pieces of information:

  1. A structured representation of the Table of Contents for the whole
    doc bundle.

  2. Rendered HTML for the anchors in the page (similar to the "toc"
    available in the page, but without the page's own header).

These can be used by consumers (including our website) to pull out this
structured information without having to parse the docsets themselves.

Unit tests pass on all supported versions of Sphinx and Python.

Built the docs and checked for build errors, bad links, and presentation
issues.

Summary ID
Add a Sphinx extension for enhanced JSON writing.
This augments the `JSONHTMLWriter` found in `sphinxcontrib-serializinghtml` (or native to Sphinx in the old-but-still-supported 1.8) to include two new pieces of information: 1. A structured representation of the Table of Contents for the whole doc bundle. 2. Rendered HTML for the anchors in the page (similar to the "toc" available in the page, but without the page's own header). These can be used by consumers (including our website) to pull out this structured information without having to parse the docsets themselves.
fce2a4775febc5d1cc264ecd289ab7f2a13db04f
Description From Last Updated

'typing.Any' imported but unused Column: 1 Error code: F401

reviewbotreviewbot
Checks run (1 failed, 1 succeeded)
flake8 failed.
JSHint passed.

flake8

david
  1. Ship It!
  2. 
      
chipx86
Review request changed
Status:
Completed
Change Summary:
Pushed to master (c84408d)