diff options
| author | Gael Pasgrimaud <gael@gawel.org> | 2011-01-28 18:33:45 +0100 |
|---|---|---|
| committer | Gael Pasgrimaud <gael@gawel.org> | 2011-01-28 18:33:45 +0100 |
| commit | 1d405df44e5df1e5c64611ae972e43975bb54a18 (patch) | |
| tree | 65f43b8d565bb6e58ee907d94cb4d72ba658d07c /docs | |
| parent | ad8b0f0df06f54f26293fd656cc21b66d84ba4b7 (diff) | |
| download | disutils2-1d405df44e5df1e5c64611ae972e43975bb54a18.tar.gz | |
add DistributionMetadata to apiref. fix directives in modules documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/distutils/apiref.rst | 7 | ||||
| -rw-r--r-- | docs/source/distutils/examples.rst | 2 | ||||
| -rw-r--r-- | docs/source/library/distutils2.metadata.rst | 8 |
3 files changed, 13 insertions, 4 deletions
diff --git a/docs/source/distutils/apiref.rst b/docs/source/distutils/apiref.rst index 02e4158..c43ec2e 100644 --- a/docs/source/distutils/apiref.rst +++ b/docs/source/distutils/apiref.rst @@ -1055,6 +1055,13 @@ This module contains some utility functions for operating on individual files. Create a file called *filename* and write *contents* (a sequence of strings without line terminators) to it. +:mod:`distutils2.metadata` --- Metadata handling +================================================================ + +.. module:: distutils2.metadata + +.. autoclass:: distutils2.metadata.DistributionMetadata + :members: :mod:`distutils2.util` --- Miscellaneous other utility functions ================================================================ diff --git a/docs/source/distutils/examples.rst b/docs/source/distutils/examples.rst index fb89dc9..fe6f482 100644 --- a/docs/source/distutils/examples.rst +++ b/docs/source/distutils/examples.rst @@ -301,7 +301,7 @@ You can read back this static file, by using the :class:`distutils2.dist.DistributionMetadata` class and its :func:`read_pkg_file` method:: - >>> from distutils2.dist import DistributionMetadata + >>> from distutils2.metadata import DistributionMetadata >>> metadata = DistributionMetadata() >>> metadata.read_pkg_file(open('distribute-0.6.8-py2.7.egg-info')) >>> metadata.name diff --git a/docs/source/library/distutils2.metadata.rst b/docs/source/library/distutils2.metadata.rst index 9f4f693..c04dec5 100644 --- a/docs/source/library/distutils2.metadata.rst +++ b/docs/source/library/distutils2.metadata.rst @@ -2,7 +2,9 @@ Metadata ======== -Distutils2 provides a :class:`DistributionMetadata` class that can read and +.. module:: distutils2.metadata + +Distutils2 provides a :class:`~distutils2.metadata.DistributionMetadata` class that can read and write metadata files. This class is compatible with all metadata versions: * 1.0: :PEP:`241` @@ -17,7 +19,7 @@ markers, and displays warnings when versions that are supposed to be Reading metadata ================ -The :class:`DistributionMetadata` class can be instantiated with the path of +The :class:`~distutils2.metadata.DistributionMetadata` class can be instantiated with the path of the metadata file, and provides a dict-like interface to the values:: >>> from distutils2.metadata import DistributionMetadata @@ -33,7 +35,7 @@ the metadata file, and provides a dict-like interface to the values:: The fields that supports environment markers can be automatically ignored if the object is instantiated using the ``platform_dependent`` option. -:class:`DistributionMetadata` will interpret in the case the markers and will +:class:`~distutils2.metadata.DistributionMetadata` will interpret in the case the markers and will automatically remove the fields that are not compliant with the running environment. Here's an example under Mac OS X. The win32 dependency we saw earlier is ignored:: |
