diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2021-11-17 21:11:49 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-05 09:14:33 +0000 |
| commit | 5d4ce7df84cc92d316934083bf50ecfc30ee6b83 (patch) | |
| tree | 11a15d2fc37e85244db891a859d681290024b426 /docs/userguide | |
| parent | 45e2c439a4b31bcf21086e1805a48281d899aa31 (diff) | |
| download | python-setuptools-git-5d4ce7df84cc92d316934083bf50ecfc30ee6b83.tar.gz | |
Improve autodoc for finder exclude
Diffstat (limited to 'docs/userguide')
| -rw-r--r-- | docs/userguide/package_discovery.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/userguide/package_discovery.rst b/docs/userguide/package_discovery.rst index 5ab854b8..a6b5061c 100644 --- a/docs/userguide/package_discovery.rst +++ b/docs/userguide/package_discovery.rst @@ -110,9 +110,9 @@ that correspond to well-known conventions, such as distributing documentation alongside the project code) are automatically filtered in the case of *flat-layouts*: -.. autodata:: setuptools.discovery.FlatLayoutPackageFinder.DEFAULT_EXCLUDE +.. autoattribute:: setuptools.discovery.FlatLayoutPackageFinder.DEFAULT_EXCLUDE -.. autodata:: setuptools.discovery.FlatLayoutModuleFinder.DEFAULT_EXCLUDE +.. autoattribute:: setuptools.discovery.FlatLayoutModuleFinder.DEFAULT_EXCLUDE Also note that you can customise your project layout by explicitly setting :doc:`package_dir <userguide/declarative_config>`. @@ -123,12 +123,6 @@ Also note that you can customise your project layout by explicitly setting place. -.. [#layout1] https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure -.. [#layout2] https://blog.ionelmc.ro/2017/09/25/rehashing-the-src-layout/ - -.. _editable install: https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs - - Using setuptools functions ========================== @@ -346,3 +340,9 @@ file contains the following: __path__ = __import__('pkgutil').extend_path(__path__, __name__) The project layout remains the same and ``setup.cfg`` remains the same. + + +.. [#layout1] https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure +.. [#layout2] https://blog.ionelmc.ro/2017/09/25/rehashing-the-src-layout/ + +.. _editable install: https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs |