summaryrefslogtreecommitdiffstats
path: root/Doc/library/site.rst
diff options
context:
space:
mode:
authorInada Naoki <songofacandy@gmail.com>2020-01-07 07:58:40 (GMT)
committerGitHub <noreply@github.com>2020-01-07 07:58:40 (GMT)
commitca94677a6216e2d41b04574986ce49d31a0b329c (patch)
tree49ae98060f6e3258cd75e98bb797b0cf61f49d59 /Doc/library/site.rst
parentf4800b8ed3dbe15a0078869a836d968ab3362b8c (diff)
downloadcpython-ca94677a6216e2d41b04574986ce49d31a0b329c.zip
cpython-ca94677a6216e2d41b04574986ce49d31a0b329c.tar.gz
cpython-ca94677a6216e2d41b04574986ce49d31a0b329c.tar.bz2
bpo-38623: Doc: Add section for site module CLI. (GH-17858)
Diffstat (limited to 'Doc/library/site.rst')
-rw-r--r--Doc/library/site.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/library/site.rst b/Doc/library/site.rst
index e1ca160..b424e1b 100644
--- a/Doc/library/site.rst
+++ b/Doc/library/site.rst
@@ -236,6 +236,13 @@ Module contents
.. versionadded:: 3.2
+.. _site-commandline:
+
+Command Line Interface
+----------------------
+
+.. program:: site
+
The :mod:`site` module also provides a way to get the user directories from the
command line:
@@ -244,8 +251,6 @@ command line:
$ python3 -m site --user-site
/home/user/.local/lib/python3.3/site-packages
-.. program:: site
-
If it is called without arguments, it will print the contents of
:data:`sys.path` on the standard output, followed by the value of
:data:`USER_BASE` and whether the directory exists, then the same thing for