summaryrefslogtreecommitdiffstats
path: root/Doc/packaging
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2011-06-09 06:15:47 (GMT)
committerÉric Araujo <merwok@netwok.org>2011-06-09 06:15:47 (GMT)
commita462a80722eace73193f7abf106a12ec5867910c (patch)
tree0cde334b92d51507ce58daa42d0d1de200ce9f73 /Doc/packaging
parent0a975f957da0a29f6a93acb836eb50070dc63f72 (diff)
downloadcpython-a462a80722eace73193f7abf106a12ec5867910c.zip
cpython-a462a80722eace73193f7abf106a12ec5867910c.tar.gz
cpython-a462a80722eace73193f7abf106a12ec5867910c.tar.bz2
Fix incorrect nesting of sections in setup.cfg specification
Diffstat (limited to 'Doc/packaging')
-rw-r--r--Doc/packaging/setupcfg.rst36
1 files changed, 18 insertions, 18 deletions
diff --git a/Doc/packaging/setupcfg.rst b/Doc/packaging/setupcfg.rst
index d3fc07a9..b657d14 100644
--- a/Doc/packaging/setupcfg.rst
+++ b/Doc/packaging/setupcfg.rst
@@ -147,7 +147,7 @@ command sections
Global options
-==============
+--------------
Contains global options for Packaging. This section is shared with Distutils.
@@ -185,7 +185,7 @@ setup_hook
Metadata
-========
+--------
The metadata section contains the metadata for the project as described in
:PEP:`345`. Field names are case-insensitive.
@@ -308,7 +308,7 @@ from the fields present in the file.
Files
-=====
+-----
This section describes the files included in the project.
@@ -352,7 +352,7 @@ Example::
Resources
----------
+^^^^^^^^^
This section describes the files used by the project which must not be installed
in the same place that python modules or libraries, they are called
@@ -448,10 +448,10 @@ Where {datafir} category will be platform-dependent.
More control on source part
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""""""
Glob syntax
-"""""""""""
+'''''''''''
When you declare source file, you can use a glob-like syntax to match multiples file, for example::
@@ -469,7 +469,7 @@ Glob tokens are:
.. TODO Add examples
Order of declaration
-""""""""""""""""""""
+''''''''''''''''''''
The order of declaration is important if one file match multiple rules. The last
rules matched by file is used, this is useful if you have this source tree::
@@ -492,7 +492,7 @@ one by one, you can declare them in this way::
doc/README = {help}
Exclude
-"""""""
+'''''''
You can exclude some files of resources declaration by giving no destination, it
can be useful if you have a non-resources file in the same directory of
@@ -513,12 +513,12 @@ Your **files** section will be::
doc/RELEASES =
More control on destination part
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+""""""""""""""""""""""""""""""""
.. _setupcfg-resources-base-prefix:
Defining a base prefix
-""""""""""""""""""""""
+''''''''''''''''''''''
When you define your resources, you can have more control of how the final path
is computed.
@@ -577,7 +577,7 @@ path will be::
Overwriting paths for categories
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+""""""""""""""""""""""""""""""""
This part is intended for system administrators or downstream OS packagers.
@@ -614,18 +614,18 @@ The platform-dependent categories are:
Defining extra categories
-^^^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""""
.. TODO
Examples
-^^^^^^^^
+""""""""
These examples are incremental but work unitarily.
Resources in root dir
-"""""""""""""""""""""
+'''''''''''''''''''''
Source tree::
@@ -647,7 +647,7 @@ So babar.sh and launch.sh will be placed in {scripts} directory.
Now let's move all the scripts into a scripts directory.
Resources in sub-directory
-""""""""""""""""""""""""""
+''''''''''''''''''''''''''
Source tree::
@@ -673,7 +673,7 @@ scripts into {scripts} instead of {scripts}/scripts.
Now let's add some docs.
Resources in multiple sub-directories
-"""""""""""""""""""""""""""""""""""""
+'''''''''''''''''''''''''''''''''''''
Source tree::
@@ -706,7 +706,7 @@ file is used.
Now let's add some scripts for windows users.
Complete example
-""""""""""""""""
+''''''''''''''''
Source tree::
@@ -737,7 +737,7 @@ We use brace expansion syntax to place all the shell and batch scripts into
Command sections
-================
+----------------
To pass options to commands without having to type them on the command line
for each invocation, you can write them in the :file:`setup.cfg` file, in a