Skip to content

Commit

Permalink
Close #6
Browse files Browse the repository at this point in the history
  • Loading branch information
goatsweater committed May 19, 2022
1 parent 47a79f8 commit 0e10561
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/structure/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,37 @@ an underscore are not shown to users.

For more information, see the `cookiecutter`_ package documentation.

``pyproject.toml``
^^^^^^^^^^^^^^^^^^

A :abbr:`TOML (Tom's Obvious Minimal Language)` file for `PEP 518`_ Python project
configuration. At a minimum this file is used to specify the build system of the project,
but can also be used for configuration for additional packages.

.. note::

This file replaces the :file:`setup.py` file original used by setuptools.

More information can be found in the `Python packaging user guide`_ and `pip specific`_
documentation.

``README.md``
^^^^^^^^^^^^^

An overview of the repository with a brief description of its purpose to inform
people what the project.

``setup.cfg``
^^^^^^^^^^^^^

A configuration file to provide static metadata used by setuptools. This provides
information such as the name and version of the package, but can also be used to provide
additional metadata necessary when publishing a package.

More information can be found in the `Python packaging user guide`_.

.. _detect-secrets: https://github.com/Yelp/detect-secrets
.. _cookiecutter: https://cookiecutter.readthedocs.io/
.. _PEP 518: https://peps.python.org/pep-0518/
.. _Python packaging user guide: https://packaging.python.org/en/latest/tutorials/packaging-projects/#configuring-metadata
.. _pip specific: https://pip.pypa.io/en/stable/reference/build-system/pyproject-toml/

0 comments on commit 0e10561

Please sign in to comment.