Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a462a80

Browse files
committed
Fix incorrect nesting of sections in setup.cfg specification
1 parent 0a975f9 commit a462a80

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

Doc/packaging/setupcfg.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ command sections
147147

148148

149149
Global options
150-
==============
150+
--------------
151151

152152
Contains global options for Packaging. This section is shared with Distutils.
153153

@@ -185,7 +185,7 @@ setup_hook
185185

186186

187187
Metadata
188-
========
188+
--------
189189

190190
The metadata section contains the metadata for the project as described in
191191
:PEP:`345`. Field names are case-insensitive.
@@ -308,7 +308,7 @@ from the fields present in the file.
308308

309309

310310
Files
311-
=====
311+
-----
312312

313313
This section describes the files included in the project.
314314

@@ -352,7 +352,7 @@ Example::
352352

353353

354354
Resources
355-
---------
355+
^^^^^^^^^
356356

357357
This section describes the files used by the project which must not be installed
358358
in the same place that python modules or libraries, they are called
@@ -448,10 +448,10 @@ Where {datafir} category will be platform-dependent.
448448

449449

450450
More control on source part
451-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
451+
"""""""""""""""""""""""""""
452452

453453
Glob syntax
454-
"""""""""""
454+
'''''''''''
455455

456456
When you declare source file, you can use a glob-like syntax to match multiples file, for example::
457457

@@ -469,7 +469,7 @@ Glob tokens are:
469469
.. TODO Add examples
470470
471471
Order of declaration
472-
""""""""""""""""""""
472+
''''''''''''''''''''
473473

474474
The order of declaration is important if one file match multiple rules. The last
475475
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::
492492
doc/README = {help}
493493

494494
Exclude
495-
"""""""
495+
'''''''
496496

497497
You can exclude some files of resources declaration by giving no destination, it
498498
can be useful if you have a non-resources file in the same directory of
@@ -513,12 +513,12 @@ Your **files** section will be::
513513
doc/RELEASES =
514514

515515
More control on destination part
516-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
516+
""""""""""""""""""""""""""""""""
517517

518518
.. _setupcfg-resources-base-prefix:
519519

520520
Defining a base prefix
521-
""""""""""""""""""""""
521+
''''''''''''''''''''''
522522

523523
When you define your resources, you can have more control of how the final path
524524
is computed.
@@ -577,7 +577,7 @@ path will be::
577577

578578

579579
Overwriting paths for categories
580-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
580+
""""""""""""""""""""""""""""""""
581581

582582
This part is intended for system administrators or downstream OS packagers.
583583

@@ -614,18 +614,18 @@ The platform-dependent categories are:
614614

615615

616616
Defining extra categories
617-
^^^^^^^^^^^^^^^^^^^^^^^^^
617+
"""""""""""""""""""""""""
618618

619619
.. TODO
620620
621621
622622
Examples
623-
^^^^^^^^
623+
""""""""
624624

625625
These examples are incremental but work unitarily.
626626

627627
Resources in root dir
628-
"""""""""""""""""""""
628+
'''''''''''''''''''''
629629

630630
Source tree::
631631

@@ -647,7 +647,7 @@ So babar.sh and launch.sh will be placed in {scripts} directory.
647647
Now let's move all the scripts into a scripts directory.
648648

649649
Resources in sub-directory
650-
""""""""""""""""""""""""""
650+
''''''''''''''''''''''''''
651651

652652
Source tree::
653653

@@ -673,7 +673,7 @@ scripts into {scripts} instead of {scripts}/scripts.
673673
Now let's add some docs.
674674

675675
Resources in multiple sub-directories
676-
"""""""""""""""""""""""""""""""""""""
676+
'''''''''''''''''''''''''''''''''''''
677677

678678
Source tree::
679679

@@ -706,7 +706,7 @@ file is used.
706706
Now let's add some scripts for windows users.
707707

708708
Complete example
709-
""""""""""""""""
709+
''''''''''''''''
710710

711711
Source tree::
712712

@@ -737,7 +737,7 @@ We use brace expansion syntax to place all the shell and batch scripts into
737737

738738

739739
Command sections
740-
================
740+
----------------
741741

742742
To pass options to commands without having to type them on the command line
743743
for each invocation, you can write them in the :file:`setup.cfg` file, in a

0 commit comments

Comments
 (0)