summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-05 03:34:34 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-05 03:34:34 -0700
commit7c29ea97c6617d1f6b2f621bf88aa6a0ab0209fa (patch)
tree0489a91670f5511ccc519181f7432eb1990b236b /docs
parentb9b31f0ca0dead8dd3835f26d6db6c53c8c7b72c (diff)
downloadpyramid-7c29ea97c6617d1f6b2f621bf88aa6a0ab0209fa.tar.gz
pyramid-7c29ea97c6617d1f6b2f621bf88aa6a0ab0209fa.tar.bz2
pyramid-7c29ea97c6617d1f6b2f621bf88aa6a0ab0209fa.zip
- replace easy_install with pip
- add python3 for intersphinx. See #2429 - minor grammar
Diffstat (limited to 'docs')
-rw-r--r--docs/quick_tutorial/conf.py3
-rw-r--r--docs/quick_tutorial/package.rst40
2 files changed, 21 insertions, 22 deletions
diff --git a/docs/quick_tutorial/conf.py b/docs/quick_tutorial/conf.py
index 47b8fae41..feebdf02a 100644
--- a/docs/quick_tutorial/conf.py
+++ b/docs/quick_tutorial/conf.py
@@ -257,6 +257,9 @@ intersphinx_mapping = {
'python': (
'http://docs.python.org/2',
None),
+ 'python3': (
+ 'https://docs.python.org/3/',
+ None),
'sqla': (
'http://docs.sqlalchemy.org/en/latest',
None),
diff --git a/docs/quick_tutorial/package.rst b/docs/quick_tutorial/package.rst
index 54a6a0bd9..9e175bdaa 100644
--- a/docs/quick_tutorial/package.rst
+++ b/docs/quick_tutorial/package.rst
@@ -10,43 +10,38 @@ Background
==========
Python developers can organize a collection of modules and files into a
-namespaced unit called a :ref:`package <python:tut-packages>`. If a
+namespaced unit called a :ref:`package <python3:tut-packages>`. If a
directory is on ``sys.path`` and has a special file named
``__init__.py``, it is treated as a Python package.
-Packages can be bundled up, made available for installation,
-and installed through a (muddled, but improving) toolchain oriented
-around a ``setup.py`` file for a
-`setuptools project <http://pythonhosted.org/setuptools/setuptools.html>`_.
-Explaining it all in this
-tutorial will induce madness. For this tutorial, this is all you need to
-know:
+Packages can be bundled up, made available for installation, and installed
+through a toolchain oriented around a ``setup.py`` file. For this tutorial,
+this is all you need to know:
-- We will have a directory for each tutorial step as a setuptools *project*
+- We will have a directory for each tutorial step as a *project*.
-- This project will contain a ``setup.py`` which injects the features
- of the setuptool's project machinery into the directory
+- This project will contain a ``setup.py`` which injects the features of the
+ project machinery into the directory.
- In this project we will make a ``tutorial`` subdirectory into a Python
- *package* using an ``__init__.py`` Python module file
+ *package* using an ``__init__.py`` Python module file.
-- We will run ``python setup.py develop`` to install our project in
- development mode
+- We will run ``pip install -e .`` to install our project in development mode.
In summary:
-- You'll do your development in a Python *package*
+- You'll do your development in a Python *package*.
-- That package will be part of a setuptools *project*
+- That package will be part of a *project*.
Objectives
==========
-- Make a Python "package" directory with an ``__init__.py``
+- Make a Python "package" directory with an ``__init__.py``.
-- Get a minimum Python "project" in place by making a ``setup.py``
+- Get a minimum Python "project" in place by making a ``setup.py``.
-- Install our ``tutorial`` project in development mode
+- Install our ``tutorial`` project in development mode.
Steps
=====
@@ -66,7 +61,7 @@ Steps
.. code-block:: bash
- $ $VENV/bin/python setup.py develop
+ $ $VENV/bin/pip install -e .
$ mkdir tutorial
#. Enter the following into ``package/tutorial/__init__.py``:
@@ -107,5 +102,6 @@ of an odd duck. We would never do this unless we were writing a tutorial that
tries to capture how this stuff works a step at a time. It's generally a bad
idea to run a Python module inside a package directly as a script.
-.. seealso:: :ref:`Python Packages <python:tut-packages>`,
- `setuptools Entry Points <http://pythonhosted.org/setuptools/pkg_resources.html#entry-points>`_
+.. seealso:: :ref:`Python Packages <python3:tut-packages>` and `Working in
+ "Development Mode"
+ <https://packaging.python.org/en/latest/distributing/#working-in-development-mode>`_.