Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Wilhelm authored and Florian Wilhelm committed Feb 25, 2015
1 parent 8870d08 commit 359de54
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ of smaller ones. For example, use::

to define ``my_package`` inside the namespace ``com.my_domain`` in java-style.

.. rubric:: Package and Files Data

Additional data inside your package (``package_data``) or in the root
directory of your project (``data_files``) can be configured in ``setup.cfg``.
To read this data in your code, use::

from pkgutil import get_data
data = get_data('my_package', 'path/to/my/data.txt')


Complete Git Integration
========================
Expand Down
9 changes: 9 additions & 0 deletions docs/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ of smaller ones. For example, use::

to define ``my_package`` inside the namespace ``com.my_domain`` in java-style.

.. rubric:: Package and Files Data

Additional data inside your package (``package_data``) or in the root
directory of your project (``data_files``) can be configured in ``setup.cfg``.
To read this data in your code, use::

from pkgutil import get_data
data = get_data('my_package', 'path/to/my/data.txt')


Complete Git Integration
========================
Expand Down
9 changes: 9 additions & 0 deletions pyscaffold/data/readme.template
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ of smaller ones. For example, use::

to define ``my_package`` inside the namespace ``com.my_domain`` in java-style.

.. rubric:: Package and Files Data

Additional data inside your package (``package_data``) or in the root
directory of your project (``data_files``) can be configured in ``setup.cfg``.
To read this data in your code, use::

from pkgutil import get_data
data = get_data('my_package', 'path/to/my/data.txt')


Complete Git Integration
========================
Expand Down

0 comments on commit 359de54

Please sign in to comment.