gh-143993: Document ways to disable remote debugging support

[RafaelWO]

Although PEP 768 mentions how to disable the mechanism of remote debugging, it is not documented in the Python docs.

This change adds a note on how to disable remote debugging support in a Python interpreter to the remote debugging how-to and to the sys.remote_exec docs.

• Issue: Document how to disable remote debugging #143993

---

📚 Documentation preview 📚:

• https://cpython-previews--143994.org.readthedocs.build/en/143994/howto/remote_debugging.html#remote-debugging
• https://cpython-previews--143994.org.readthedocs.build/en/143994/library/sys.html#sys.remote_exec

[hugovk]

Thanks for the PR! It's a good idea to document these three methods together.

@pablogsal What do you think about the placement and prominence of these?

• https://cpython-previews--143994.org.readthedocs.build/en/143994/howto/remote_debugging.html#remote-debugging
• https://cpython-previews--143994.org.readthedocs.build/en/143994/library/sys.html#sys.remote_exec

Maybe they don't need to be highlighted in a note admonition and could be regular text?

In the HOWTO, it could perhaps to its own section with a header, which will make it easier to share.

In the sys page, perhaps it could also be regular text at the end of function description (just before "Availability: Unix, Windows").

[pablogsal]

This probably deserves its own little section that appears in the sidebar :)

[RafaelWO]

Sounds good, added in 52a4439 :)

[vstinner]

I would prefer suggesting a specific value such as 1.

[RafaelWO]

Fixed in 5d7a544

[RafaelWO]

What do you think about adding a reference to the HOWTO here? For example:

See also :ref:`remote-debugging` for information about the remote debugging protocol.

[pablogsal]

@pablogsal What do you think about the placement and prominence of these?

I think the one in sys.remote_exec needs to link against the other page. Most users of that don't care about deactivating it as that is mostly an "advanced" use case I would say so I would recommend just linking to the other places

[RafaelWO]

I think the one in sys.remote_exec needs to link against the other page. Most users of that don't care about deactivating it as that is mostly an "advanced" use case I would say so I would recommend just linking to the other places

I replaced the note about how to disable remote debugging in sys.remote_exec with a link to the HOWTO (which mentions how to disable it) in a79c3cc. I hope I understood your suggestion correctly 🙂