The requested URL was not found on this server.
| Server IP : 202.155.9.250 / Your IP : 216.73.217.173 Web Server : LiteSpeed System : Linux srv339029361 5.15.0-177-generic #187-Ubuntu SMP Sat Apr 11 22:54:33 UTC 2026 x86_64 User : klfco7607 ( 1020) PHP Version : 8.0.30 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : ON Directory : /usr/share/doc/python3-pip/html/development/ |
Upload File : |
:orphan: ========================= Documentation Conventions ========================= This document describes the conventions used in pip's documentation. We expect it to evolve over time as additional conventions are identified and past conventions are rendered obsolete. .. note:: Currently, these conventions are not enforced automatically, and need to be verified manually during code review. We are interested in linters that can help us enforce these conventions automatically. Files ===== Naming ------ Folder names should be a single word, all lowercase. File names must use the kebab-case style (all lowercase, hyphen for separating words) and have the extension ``.rst``. Encoding -------- All files in our documentation must use UTF-8 encoding. Line Length ----------- Limit all lines to a maximum of 72 characters, where possible. This may be exceeded when it does not make sense to abide by it (eg. long links, code blocks). Headings ======== Use the following symbols to create headings: #. ``=`` with overline #. ``=`` #. ``-`` #. ``^`` #. ``'`` #. ``*`` For visual separation from the rest of the content, all other headings must have one empty line before and after. Heading 2 (``=``) should have two empty lines before, for indicating the end of the section prior to it. :: ========= Heading 1 ========= Lorem ipsum dolor sit amet consectetur adipisicing elit. Heading 2 ========= Lorem ipsum dolor sit amet consectetur adipisicing elit. Heading 3 --------- Lorem ipsum dolor sit amet consectetur adipisicing elit. Heading 4 ^^^^^^^^^ Lorem ipsum dolor sit amet consectetur adipisicing elit. Heading 5 ''''''''' Lorem ipsum dolor sit amet consectetur adipisicing elit. Heading 6 ********* Lorem ipsum dolor sit amet consectetur adipisicing elit. Writing ======= .. note:: We're still discussing *how* pip should be capitalized in prose. The current statement here is tentative. pip is a proper noun, and spelt all lowercase. Do not capitalize pip as "Pip" at the start of a sentence. Avoid using phrases such as "easy", "just", "simply" etc, which imply that the task is trivial. If it were trivial, the user wouldn't be reading the documentation for it.