Skip to content

Commit

Permalink
Format fix on last section of Mesa packages docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jackiekazil committed Apr 5, 2018
1 parent f8a5852 commit b093db2
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ There are two sections in this documention. The first is the User Guide, which i


User Guide
-------------------------
--------------------------------------------------

* Note: MESA does not endorse or verify any of the code shared through MESA packages. This is left to the domain experts of the community that created the code.*

Expand Down Expand Up @@ -62,7 +62,7 @@ The commands above should also work with Anaconda, just replace the `pip` with `


Package Development: A "How-to Guide"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------------------------

The purpose of this section is help you understand, setup, and distribute your Mesa package as quickly as possible. A Mesa package is just a Python package or repo. We just call it a Mesa package, because we are talking about a Python package in the context of Mesa. These instructions assume that you are a little familiar with development, but that you have little knowledge of the packaging process.

Expand All @@ -75,6 +75,7 @@ Sharing a package via PyPI make it easier to install for users but is more overh

Most likely you created an ABM that has the code that you want to share in it, which is what the steps below describe.


Sharing your package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -100,8 +101,9 @@ Sharing your package

From this point, someone can clone your repo and then add your repo to their Python path and use it in their project. However, if you want to take your package to the next level, you will want to add more structure to your package and share it on PyPI.


Next Level: PyPI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You want to do even more. The authoritative guide for python package development is through the `Python Packaging User Guide <https://packaging.python.org/>`_. This will take you through the entire process necessary for getting your package on the Python Package Index.

Expand Down

0 comments on commit b093db2

Please sign in to comment.