Skip to content

Commit bf5ffd7

Browse files
committed
Move README to be a rst.
Add links and some information on sphinx
1 parent a7c14c4 commit bf5ffd7

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
The "Python Packaging User Guide" aims to be the authoritative resource on how
2-
to package and install distributions in Python.
1+
The Python Package User Guide
2+
=============================
3+
4+
The "Python Packaging User Guide" (PPUG) aims to be the authoritative
5+
resource on how to package and install distributions in Python.
36

47
The guide is part of a larger effort to improve all of the packaging and
58
installation docs, including pip, setuptools, virtualenv, wheel, and
@@ -12,7 +15,12 @@ It was forked from the “Hitchhikers Guide to Packaging” in March 2013, which
1215
maintained by Tarek Ziadé. Thankyou Tarek for all your efforts in python
1316
packaging.
1417

15-
The html version of the Guide is currently available at
16-
https://python-packaging-user-guide.readthedocs.org.
18+
The html version of the Guide is currently available online at readthedocs.org_.
19+
20+
Please see the `source/license.txt <license>`_ file for license information.
21+
22+
This documentation project is built with the Sphinx_ documentation software.
1723

18-
Please see the `source/license.txt` file for license information.
24+
.. _readthedocs.org: https://python-packaging-user-guide.readthedocs.org
25+
.. _license: source/license.txt
26+
.. _Sphinx: https://pypi.python.org/pypi/Sphinx

0 commit comments

Comments
 (0)