diff options
| author | Saniya Maheshwari <saniya.mah@gmail.com> | 2022-06-08 20:00:50 +0530 |
|---|---|---|
| committer | Saniya Maheshwari <saniya.mah@gmail.com> | 2022-06-08 21:34:35 +0530 |
| commit | d7234012ffe4ce13360c1c2a7e8739b6c473d3e0 (patch) | |
| tree | 85b1fdbbaee752e0468a5197c2d224ed1552b3da /docs/userguide | |
| parent | 6fb421140914bf4eac1e46f6da641370a909d1bf (diff) | |
| download | python-setuptools-git-d7234012ffe4ce13360c1c2a7e8739b6c473d3e0.tar.gz | |
Changed the example illustrating usage without console scripts
- Using `src` layout for consistency with other examples in the
documentation.
- Using a tree diagram.
- Showing a `setup.py` file in the diagram with a comment indicating
that `setup.cfg` or `pyproject.toml` can also be used, again for
consistency with other examples in the documentation.
- Root directory is kept as `project_root_directory` to indicate that
any name can be used.
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/entry_point.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst index b97419c4..54d53a20 100644 --- a/docs/userguide/entry_point.rst +++ b/docs/userguide/entry_point.rst @@ -14,15 +14,15 @@ Console Scripts =============== First consider an example without entry points. Imagine a package -defined thus: - -.. code-block:: bash - - timmins/ - timmins/__init__.py - timmins/__main__.py - setup.cfg # or setup.py - #other necessary files +defined thus:: + + project_root_directory + ├── setup.py # and/or setup.cfg, pyproject.toml + └── src + └── timmins + ├── __init__.py + ├── __main__.py + └── ... with ``__init__.py`` as: |