Skip to content

Commit

Permalink
Replace repeated description of pkg files with cross-ref
Browse files Browse the repository at this point in the history
  • Loading branch information
douglatornell committed Apr 3, 2023
1 parent dbbf2e1 commit d29b1e6
Showing 1 changed file with 5 additions and 19 deletions.
24 changes: 5 additions & 19 deletions python_packaging/pkg_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,25 +115,7 @@ In summary

It typically contains 6 files and 5 sub-directories.

The 6 files are:

* :ref:`PyprojectTomlFile` that contains the build system requirements and build backend tools to use for creation of the package,
the package metadata,
the command-line interface scripts and entry points configuration
(if applicable),
and configuration for tools used for code QA and package management
(e.g. `coverage`_ and `hatch`_)

.. _coverage: https://coverage.readthedocs.io/en/latest/
.. _hatch: https://hatch.pypa.io/latest/

* :ref:`PkgReadmeRstFile` that provides the long description of the package
* :ref:`PkgLicenseFile` that contains the legal text of the Apache License, Version 2.0 license for the package
* :ref:`PkgReadthedocsYamlFile` that provides configuration for building the docs to the https://readthedocs.org service
* :ref:`PkgGitignoreFile` that provides the list of intentionally untracked files that Git should ignore
* :ref:`PkgPreCommitConfigYamlFile` that provides configuration for the `pre-commit`_ tool that is used to manage coding style and other aspects of repository QA in many packages

.. _pre-commit: https://pre-commit.com/
The 6 files are described in the :ref:`PackageFiles` section below.

The 5 sub-directories in all packages are:

Expand Down Expand Up @@ -170,6 +152,8 @@ Other examples of MOAD project and package names are:
The top-level directory "project name" is generally the name of the project's Git repository.


.. _PackageFiles:

Package Files
-------------

Expand Down Expand Up @@ -197,6 +181,8 @@ but are present in most packages:
* :ref:`PkgGitignoreFile` that provides the list of intentionally untracked files that Git should ignore
* :ref:`PkgPreCommitConfigYamlFile` that provides configuration for the `pre-commit`_ tool that is used to manage coding style and other aspects of repository QA

.. _pre-commit: https://pre-commit.com/


.. _PyprojectTomlFile:

Expand Down

0 comments on commit d29b1e6

Please sign in to comment.