On Mon, Jan 13, 2025 at 06:36:40PM +1100, Stuart Prescott wrote: > Control: tags -1 + patch > > On 13/01/2025 12:59, Stuart Prescott wrote: > > The error «(SEVERE/4) Unexpected section title.» is about the Parameters > > and Returns headings that are inserted into the API docs (running sphinx > > with `-v -v -v` revealed that). > > > > There is on-the-fly manipulation of the docstrings in jupyter_client/ > > client.py::reqrep - I was able to get the docs to build by changing the > > inserted Parameters and Returns into paragraphs rather than headings. > > I've attached a patch that does this. I don't think it's quite the right > > change to be making, but it might help someone else understand the > > problem and find a better solution. > > An alternative way to fixing this is to remove all the whitespace > indentation in the jupyter_client/client.py::reqrep function. That lets the > build complete with the headings intact... the output seems to be as > intended.
Thanks Stuart! It's a nice idea, but it messes up the Python < 3.13 docstrings. I've found a slightly better fix and submitted it as a PR and uploaded it to unstable (though I messed up the changelog, so might have to try again!). Best wishes, Julian
