Skip to content

gh-130160: use .. program:: directive for documenting venv CLI #130699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vsajip merged 13 commits into from
Jun 30, 2025
Merged

gh-130160: use .. program:: directive for documenting venv CLI #130699

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4dc832e
gh-130160 use `.. program::` directive for documenting `venv` CLI
Mr-Sunglasses Feb 28, 2025
c8ee8c3
Merge branch 'main' into venv-use-prog
Mr-Sunglasses Mar 3, 2025
a4df05e
Merge branch 'main' into venv-use-prog
Mr-Sunglasses Apr 5, 2025
1419051
Update Doc/library/venv.rst
Mr-Sunglasses Apr 5, 2025
918676c
Update Doc/library/venv.rst
Mr-Sunglasses Apr 5, 2025
f0285a2
Merge branch 'main' into venv-use-prog
Mr-Sunglasses Apr 5, 2025
34753d4
Merge branch 'main' into venv-use-prog
Mr-Sunglasses Apr 7, 2025
5385791
fix: removed duplicate line from docs
Mr-Sunglasses May 21, 2025
9a5281b
Update Doc/library/venv.rst
Mr-Sunglasses Jun 2, 2025
2d042e1
chore: reformatted flags
Mr-Sunglasses Jun 2, 2025
889cc43
chore: removed whitespaces
Mr-Sunglasses Jun 2, 2025
8a3659b
feat: add -h, --help option
Mr-Sunglasses Jun 2, 2025
e6ab47b
chore: removed -h,--help
Mr-Sunglasses Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: reformatted flags
  • Loading branch information
@Mr-Sunglasses
Mr-Sunglasses committed Jun 2, 2025
commit 2d042e16798cdc09864db1debfcabf7ef462e97c
7 changes: 4 additions & 3 deletions Doc/library/venv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@ See :pep:`405` for more background on Python virtual environments.

Creating virtual environments
-----------------------------
.. _venv-cli:
.. program:: venv

Comment thread
Mr-Sunglasses marked this conversation as resolved.
:ref:`Virtual environments <venv-def>` are created by executing the ``venv``
module:
Expand Down Expand Up @@ -110,9 +108,12 @@ The command, if run with ``-h``, will show the available options::
Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.

Comment thread
Mr-Sunglasses marked this conversation as resolved.
.. _venv-cli:
.. program:: venv

.. option:: ENV_DIR

A required argument specifying the directory to create the environment in.
A required argument specifying the directory to create the environment in.

.. option:: --system-site-packages

Expand Down