Skip to content

Commit

Permalink
Initial setup for package
Browse files Browse the repository at this point in the history
  • Loading branch information
vcalderon2009 committed Apr 18, 2018
1 parent aa1e9e0 commit 6a30c73
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/source/python_packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,24 @@ about some of the **very useful** tools that you can use in order to
- Keep your documentation up to date (ReadTheDocs)
- and more.

.. _Initial_Setup:
---------------------------------
Initial Setup
---------------------------------

In order to construct your package, you first need to setup your package
with the following folder structure:

.. code::
your_package/
LICENSE.txt
README.txt
setup.py
package_name/
__init__.py
As you can tell, there's a file named :code:`__index__.py`. This file tells
Python to treat this directory as a *module/package*. Without
this file, Python will not understand that your building a package, and
will not link the files properly.

0 comments on commit 6a30c73

Please sign in to comment.