diff options
author | Jean-Paul Pelteret <jppelteret@gmail.com> | 2016-10-08 07:46:22 +0200 |
---|---|---|
committer | Todd Gamblin <tgamblin@llnl.gov> | 2016-10-07 22:46:22 -0700 |
commit | 876c26f65828491cfe1b13ced7383747058ca9d2 (patch) | |
tree | 3ae9c083c5ee9c1c9141fac4a044cf7f93f6699f /lib | |
parent | d3daa829f070bfd6bf25cfea18f27015ee9928f5 (diff) | |
download | spack-876c26f65828491cfe1b13ced7383747058ca9d2.tar.gz spack-876c26f65828491cfe1b13ced7383747058ca9d2.tar.bz2 spack-876c26f65828491cfe1b13ced7383747058ca9d2.tar.xz spack-876c26f65828491cfe1b13ced7383747058ca9d2.zip |
Add documentation for standard python repositories. (#1970)
Fixes #1939
Diffstat (limited to 'lib')
-rw-r--r-- | lib/spack/docs/packaging_guide.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst index a4982a9071..155bbcdb08 100644 --- a/lib/spack/docs/packaging_guide.rst +++ b/lib/spack/docs/packaging_guide.rst @@ -865,6 +865,36 @@ Fetching a revision Subversion branches are handled as part of the directory structure, so you can check out a branch or tag by changing the ``url``. +----------------------------------------- +Standard repositories for python packages +----------------------------------------- + +In addition to their developer websites, many python packages are hosted at the +`Python Package Index (PyPi) <https://pypi.python.org/pypi>`_. Although links to +these individual files are typically `generated using a hash +<https://bitbucket.org/pypa/pypi/issues/438>`_ it is often possible to find a +reliable link of the format + +.. code-block:: sh + + https://pypi.python.org/packages/source/<first letter of package>/<package>/<package>-<version>.<extension> + +Packages hosted on GitHub and the like are often developer versions that do not +contain all of the files (e.g. configuration scripts) necessary to support +compilation. For this reason it is ideal to link to a repository such as PyPi +if possible. + +More recently, sources are being indexed at `pypi.io <https://pypi.io>`_ as +well. Links obtained from this site follow a similar pattern, namely + +.. code-block:: sh + + https://pypi.io/packages/source/<first letter of package>/<package>/<package>-<version>.<extension> + +These links currently redirect back to `pypi.python.org +<https://pypi.python.org>`_, but this `may change in the future +<https://bitbucket.org/pypa/pypi/issues/438#comment-27243225>`_. + ------------------------------------------------- Expanding additional resources in the source tree ------------------------------------------------- |