gh-109435: Add Doc/library/cmdline.rst (#109436)

Document modules providing a command-line interface (CLI).

diff --git a/Doc/library/asyncio.rst b/Doc/library/asyncio.rst
index c6a046f534e9a12570cf2eb1289ed014d40c520b..c75ab47404c1e4ecb9c058c7bc00b4a20b9bf57a 100644 (file)
--- a/Doc/library/asyncio.rst
+++ b/Doc/library/asyncio.rst
@@ -56,6 +56,8 @@ Additionally, there are **low-level** APIs for
 * :ref:`bridge <asyncio-futures>` callback-based libraries and code
   with async/await syntax.
 
+.. _asyncio-cli:
+
 You can experiment with an ``asyncio`` concurrent context in the REPL:
 
 .. code-block:: pycon

diff --git a/Doc/library/cmdline.rst b/Doc/library/cmdline.rst
new file mode 100644 (file)
index 0000000..4a295e0
--- /dev/null
+++ b/Doc/library/cmdline.rst
@@ -0,0 +1,57 @@
+++++++++++++++++++++++++++++++++++++
+Modules command-line interface (CLI)
+++++++++++++++++++++++++++++++++++++
+
+The following modules have a command-line interface.
+
+* :ref:`ast <ast-cli>`
+* :ref:`asyncio <asyncio-cli>`
+* :mod:`base64`
+* :ref:`calendar <calendar-cli>`
+* :mod:`code`
+* :ref:`compileall <compileall-cli>`
+* :mod:`cProfile`: see :ref:`profile <profile-cli>`
+* :ref:`difflib <difflib-interface>`
+* :mod:`dis`
+* :mod:`doctest`
+* :mod:`!encodings.rot_13`
+* :mod:`ensurepip`
+* :mod:`filecmp`
+* :mod:`fileinput`
+* :mod:`ftplib`
+* :ref:`gzip <gzip-cli>`
+* :ref:`http.server <http-server-cli>`
+* :mod:`!idlelib`
+* :ref:`inspect <inspect-module-cli>`
+* :ref:`json.tool <json-commandline>`
+* :mod:`mimetypes`
+* :mod:`pdb`
+* :mod:`pickle`
+* :ref:`pickletools <pickletools-cli>`
+* :mod:`platform`
+* :mod:`poplib`
+* :ref:`profile <profile-cli>`
+* :mod:`pstats`
+* :ref:`py_compile <py_compile-cli>`
+* :mod:`pyclbr`
+* :mod:`pydoc`
+* :mod:`quopri`
+* :mod:`runpy`
+* :ref:`site <site-commandline>`
+* :ref:`sqlite3 <sqlite3-cli>`
+* :ref:`sysconfig <sysconfig-cli>`
+* :mod:`tabnanny`
+* :ref:`tarfile <tarfile-commandline>`
+* :mod:`!this`
+* :ref:`timeit <timeit-command-line-interface>`
+* :ref:`tokenize <tokenize-cli>`
+* :ref:`trace <trace-cli>`
+* :mod:`turtledemo`
+* :ref:`unittest <unittest-command-line-interface>`
+* :ref:`uuid <uuid-cli>`
+* :mod:`venv`
+* :mod:`webbrowser`
+* :ref:`zipapp <zipapp-command-line-interface>`
+* :ref:`zipfile <zipfile-commandline>`
+
+See also the :ref:`Python command-line interface <using-on-general>`.

diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst
index 4226348a17240a53607226b2c9e21bda3d5e49ac..80d96eca71f2759bff411fbdc94df3945925809b 100644 (file)
--- a/Doc/library/compileall.rst
+++ b/Doc/library/compileall.rst
@@ -16,6 +16,8 @@ have write permission to the library directories.
 
 .. include:: ../includes/wasm-notavail.rst
 
+.. _compileall-cli:
+
 Command-line use
 ----------------
 

diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst
index 60236a1190e4232fd424f031d3c6ad08b89741d7..6a4f2c76ae4e10c7bb519a67c97d4c6eefdf7a80 100644 (file)
--- a/Doc/library/gzip.rst
+++ b/Doc/library/gzip.rst
@@ -250,6 +250,8 @@ Example of how to GZIP compress a binary string::
 
 .. program:: gzip
 
+.. _gzip-cli:
+
 Command Line Interface
 ----------------------
 

diff --git a/Doc/library/index.rst b/Doc/library/index.rst
index d064b680f9aaa47e0a05146815ed2b3ebda3359c..0b348ae6f5c8c0af9de243e142dda8b02fd3a7c9 100644 (file)
--- a/Doc/library/index.rst
+++ b/Doc/library/index.rst
@@ -73,5 +73,6 @@ the `Python Package Index <https://pypi.org>`_.
    language.rst
    windows.rst
    unix.rst
+   cmdline.rst
    superseded.rst
    security_warnings.rst

diff --git a/Doc/library/pickletools.rst b/Doc/library/pickletools.rst
index 480f4a6d3208156f0add93d636045592ca35bc9c..76f5b0cadf975a7846f07d3d47b48dff8c77fc3a 100644 (file)
--- a/Doc/library/pickletools.rst
+++ b/Doc/library/pickletools.rst
@@ -17,6 +17,8 @@ are useful for Python core developers who are working on the :mod:`pickle`;
 ordinary users of the :mod:`pickle` module probably won't find the
 :mod:`pickletools` module relevant.
 
+.. _pickletools-cli:
+
 Command line usage
 ------------------
 

diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index 723f927135a0f4f811236b9954271bbe9a28973a..69274b0c354a25dd0e2cec31802ee0dea997e0d0 100644 (file)
--- a/Doc/library/profile.rst
+++ b/Doc/library/profile.rst
@@ -121,6 +121,8 @@ results to a file by specifying a filename to the :func:`run` function::
 The :class:`pstats.Stats` class reads profile results from a file and formats
 them in various ways.
 
+.. _profile-cli:
+
 The files :mod:`cProfile` and :mod:`profile` can also be invoked as a script to
 profile another script.  For example::
 

diff --git a/Doc/library/py_compile.rst b/Doc/library/py_compile.rst
index 69b93a3bdfcb2655cab928cc6fa42332f6702fe7..5501db8f87de81b1c2102721756f40d42759f70d 100644 (file)
--- a/Doc/library/py_compile.rst
+++ b/Doc/library/py_compile.rst
@@ -125,6 +125,7 @@ byte-code cache files in the directory containing the source code.
       This option is useful when the ``.pycs`` are kept up to date by some
       system external to Python like a build system.
 
+.. _py_compile-cli:
 
 Command-Line Interface
 ----------------------

diff --git a/Doc/library/sysconfig.rst b/Doc/library/sysconfig.rst
index 26344ea4e7e2ab9721e0528f3c265d7ee2338a17..c625c1e1d72954bb2c214043e01010c0b45083ec 100644 (file)
--- a/Doc/library/sysconfig.rst
+++ b/Doc/library/sysconfig.rst
@@ -278,6 +278,7 @@ Other functions
 
    Return the path of :file:`Makefile`.
 
+.. _sysconfig-cli:
 
 Using :mod:`sysconfig` as a script
 ----------------------------------