Skip to content

Commit 68d5dcb

Browse files
committed
Make args names literal in distributing-packages
1 parent e4ea4a1 commit 68d5dcb

1 file changed

Lines changed: 41 additions & 40 deletions

File tree

source/guides/distributing-packages-using-setuptools.rst

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@ taken from the `setup.py
160160

161161
.. _`setup() name`:
162162

163-
name
164-
~~~~
163+
``name``
164+
~~~~~~~~
165165

166166
::
167167

@@ -186,8 +186,8 @@ declare a dependency on it using any of the following spellings::
186186
CoOl__-.-__sTuFF
187187

188188

189-
version
190-
~~~~~~~
189+
``version``
190+
~~~~~~~~~~~
191191

192192
::
193193

@@ -210,8 +210,8 @@ rather not duplicate the value, there are a few ways to manage this. See the
210210

211211
.. _`description`:
212212

213-
description
214-
~~~~~~~~~~~
213+
``description``
214+
~~~~~~~~~~~~~~~
215215

216216
::
217217

@@ -241,8 +241,8 @@ to no formatting, `reStructuredText (reST)
241241
and the Github-flavored Markdown dialect of `Markdown
242242
<https://daringfireball.net/projects/markdown/>`_ respectively.
243243

244-
url
245-
~~~
244+
``url``
245+
~~~~~~~
246246

247247
::
248248

@@ -252,8 +252,8 @@ url
252252
Give a homepage URL for your project.
253253

254254

255-
author
256-
~~~~~~
255+
``author``
256+
~~~~~~~~~~
257257

258258
::
259259

@@ -263,8 +263,8 @@ author
263263
Provide details about the author.
264264

265265

266-
license
267-
~~~~~~~
266+
``license``
267+
~~~~~~~~~~~
268268

269269
::
270270

@@ -276,15 +276,15 @@ so if you want. If you're using a standard, well-known license, then
276276
your main indication can and should be via the ``classifiers``
277277
argument. Classifiers exist for all major open-source licenses.
278278

279-
The "license" argument is more typically used to indicate differences
279+
The ``license`` argument is more typically used to indicate differences
280280
from well-known licenses, or to include your own, unique license. As a
281281
general rule, it's a good idea to use a standard, well-known license,
282282
both to avoid confusion and because some organizations avoid software
283283
whose license is unapproved.
284284

285285

286-
classifiers
287-
~~~~~~~~~~~
286+
``classifiers``
287+
~~~~~~~~~~~~~~~
288288

289289
::
290290

@@ -323,8 +323,8 @@ Python versions a project can be installed on, use the :ref:`python_requires`
323323
argument.
324324

325325

326-
keywords
327-
~~~~~~~~
326+
``keywords``
327+
~~~~~~~~~~~~
328328

329329
::
330330

@@ -333,8 +333,8 @@ keywords
333333
List keywords that describe your project.
334334

335335

336-
project_urls
337-
~~~~~~~~~~~~
336+
``project_urls``
337+
~~~~~~~~~~~~~~~~
338338

339339
::
340340

@@ -351,8 +351,8 @@ bug trackers, source repositories, or where to support package development.
351351
The string of the key is the exact text that will be displayed on PyPI.
352352

353353

354-
packages
355-
~~~~~~~~
354+
``packages``
355+
~~~~~~~~~~~~
356356

357357
::
358358

@@ -366,8 +366,8 @@ packages. Use the ``exclude`` keyword argument to omit packages that are not
366366
intended to be released and installed.
367367

368368

369-
py_modules
370-
~~~~~~~~~~
369+
``py_modules``
370+
~~~~~~~~~~~~~~
371371

372372
::
373373

@@ -378,8 +378,8 @@ package, set ``py_modules`` to a list of the names of the modules (minus the
378378
``.py`` extension) in order to make :ref:`setuptools` aware of them.
379379

380380

381-
install_requires
382-
~~~~~~~~~~~~~~~~
381+
``install_requires``
382+
~~~~~~~~~~~~~~~~~~~~
383383

384384
::
385385

@@ -394,8 +394,8 @@ For more on using "install_requires" see :ref:`install_requires vs Requirements
394394

395395
.. _python_requires:
396396

397-
python_requires
398-
~~~~~~~~~~~~~~~
397+
``python_requires``
398+
~~~~~~~~~~~~~~~~~~~
399399

400400
If your project only runs on certain Python versions, setting the
401401
``python_requires`` argument to the appropriate :pep:`440` version specifier
@@ -427,8 +427,8 @@ And so on.
427427

428428
.. _`Package Data`:
429429

430-
package_data
431-
~~~~~~~~~~~~
430+
``package_data``
431+
~~~~~~~~~~~~~~~~
432432

433433
::
434434

@@ -453,8 +453,8 @@ For more information, see :std:doc:`Including Data Files
453453

454454
.. _`Data Files`:
455455

456-
data_files
457-
~~~~~~~~~~
456+
``data_files``
457+
~~~~~~~~~~~~~~
458458

459459
::
460460

@@ -487,17 +487,17 @@ For more information see the distutils section on `Installing Additional Files
487487
then you need to pass the ``--old-and-unmanageable`` option.
488488

489489

490-
scripts
491-
~~~~~~~
490+
``scripts``
491+
~~~~~~~~~~~
492492

493493
Although ``setup()`` supports a `scripts
494494
<http://docs.python.org/3/distutils/setupscript.html#installing-scripts>`_
495495
keyword for pointing to pre-made scripts to install, the recommended approach to
496496
achieve cross-platform compatibility is to use :ref:`console_scripts` entry
497497
points (see below).
498498

499-
entry_points
500-
~~~~~~~~~~~~
499+
``entry_points``
500+
~~~~~~~~~~~~~~~~
501501

502502
::
503503

@@ -517,8 +517,8 @@ The most commonly used entry point is "console_scripts" (see below).
517517

518518
.. _`console_scripts`:
519519

520-
console_scripts
521-
***************
520+
``console_scripts``
521+
*******************
522522

523523
::
524524

@@ -528,7 +528,7 @@ console_scripts
528528
],
529529
},
530530

531-
Use "console_script" `entry points
531+
Use ``console_script`` `entry points
532532
<https://setuptools.readthedocs.io/en/latest/setuptools.html#dynamic-discovery-of-services-and-plugins>`_
533533
to register your script interfaces. You can then let the toolchain handle the
534534
work of turning these interfaces into actual scripts [2]_. The scripts will be
@@ -674,8 +674,9 @@ Assuming you're in the root of your project directory, then run:
674674
Although somewhat cryptic, ``-e`` is short for ``--editable``, and ``.`` refers
675675
to the current working directory, so together, it means to install the current
676676
directory (i.e. your project) in editable mode. This will also install any
677-
dependencies declared with "install_requires" and any scripts declared with
678-
"console_scripts". Dependencies will be installed in the usual, non-editable mode.
677+
dependencies declared with ``install_requires`` and any scripts declared with
678+
``console_scripts``. Dependencies will be installed in the usual, non-editable
679+
mode.
679680

680681
It's fairly common to also want to install some of your dependencies in editable
681682
mode as well. For example, supposing your project requires "foo" and "bar", but

0 commit comments

Comments
 (0)