OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	06/10/2025 09:51:14 PM	rwxr-xr-x
📁 architecture	-	06/10/2025 09:51:14 PM	rwxr-xr-x
📄 ci.rst.gz	1.09 KB	02/03/2024 09:48:10 AM	rw-r--r--
📄 contributing.rst.gz	4.35 KB	02/03/2024 09:48:10 AM	rw-r--r--
📄 conventions.rst	2.23 KB	02/03/2024 09:48:10 AM	rw-r--r--
📄 getting-started.rst.gz	2.49 KB	02/03/2024 09:48:10 AM	rw-r--r--
📄 index.rst	921 bytes	02/03/2024 09:48:10 AM	rw-r--r--
📄 issue-triage.md.gz	5.19 KB	02/03/2024 09:48:10 AM	rw-r--r--
📄 release-process.rst.gz	3.15 KB	02/03/2024 09:48:10 AM	rw-r--r--
📄 vendoring-policy.rst	49 bytes	02/03/2024 09:48:10 AM	rw-r--r--

Editing: conventions.rst

: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
   =========