From fdc6975c2c1c2824dbbab543ddc62fc9e3d1655a Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 2 Jan 2013 22:27:50 +0200 Subject: Reduce duplicated installation instructions from the tutorials * This also removes the mention of running 'source bin/activate' (see #759). --- docs/tutorials/wiki/installation.rst | 93 ++--------------------------------- docs/tutorials/wiki2/installation.rst | 35 ++----------- 2 files changed, 9 insertions(+), 119 deletions(-) (limited to 'docs') diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst index 868c99dee..488ab1883 100644 --- a/docs/tutorials/wiki/installation.rst +++ b/docs/tutorials/wiki/installation.rst @@ -2,52 +2,15 @@ Installation ============ -For the most part, the installation process for this tutorial -duplicates the steps described in :ref:`installing_chapter` and -:ref:`project_narr`, however it also explains how to install -additional libraries for tutorial purposes. - Preparation -======================== +=========== -Please take the following steps to prepare for the tutorial. The -steps to prepare for the tutorial are slightly different depending on -whether you're using UNIX or Windows. +Follow the steps in :ref:`installing_chapter`, but name the virtualenv +directory ``pyramidtut``. Preparation, UNIX ----------------- -#. If you don't already have a Python 2.6 interpreter installed on - your system, obtain, install, or find `Python 2.6 - `_ for your system. - -#. Make sure the Python development headers are installed on your system. If - you've installed Python from source, these will already be installed. If - you're using a system Python, you may have to install a ``python-dev`` - package (e.g. ``apt-get python-dev``). The headers are not required for - Pyramid itself, just for dependencies of the tutorial. - -#. Install the latest `setuptools` into the Python you - obtained/installed/found in the step above: download `ez_setup.py - `_ and run it using - the ``python`` interpreter of your Python 2.6 installation: - - .. code-block:: text - - $ /path/to/my/Python-2.6/bin/python ez_setup.py - -#. Use that Python's `bin/easy_install` to install `virtualenv`: - - .. code-block:: text - - $ /path/to/my/Python-2.6/bin/easy_install virtualenv - -#. Use that Python's virtualenv to make a workspace: - - .. code-block:: text - - $ path/to/my/Python-2.6/bin/virtualenv --no-site-packages \ - pyramidtut #. Switch to the ``pyramidtut`` directory: @@ -55,18 +18,7 @@ Preparation, UNIX $ cd pyramidtut -#. (Optional) Consider using ``source bin/activate`` to make your - shell environment wired to use the virtualenv. - -#. Use ``easy_install`` to get :app:`Pyramid` and its direct - dependencies installed: - - .. code-block:: text - - $ bin/easy_install pyramid - -#. Use ``easy_install`` to install ``docutils``, ``pyramid_tm``, - ``pyramid_zodbconn``, ``pyramid_debugtoolbar``, ``nose`` and ``coverage``: +#. Install tutorial dependencies: .. code-block:: text @@ -76,30 +28,6 @@ Preparation, UNIX Preparation, Windows -------------------- -#. Install, or find `Python 2.6 - `_ for your system. - -#. Install the latest `setuptools` into the Python you - obtained/installed/found in the step above: download `ez_setup.py - `_ and run it using - the ``python`` interpreter of your Python 2.6 installation using a - command prompt: - - .. code-block:: text - - c:\> c:\Python26\python ez_setup.py - -#. Use that Python's `bin/easy_install` to install `virtualenv`: - - .. code-block:: text - - c:\> c:\Python26\Scripts\easy_install virtualenv - -#. Use that Python's virtualenv to make a workspace: - - .. code-block:: text - - c:\> c:\Python26\Scripts\virtualenv --no-site-packages pyramidtut #. Switch to the ``pyramidtut`` directory: @@ -107,18 +35,7 @@ Preparation, Windows c:\> cd pyramidtut -#. (Optional) Consider using ``bin\activate.bat`` to make your shell - environment wired to use the virtualenv. - -#. Use ``easy_install`` to get :app:`Pyramid` and its direct - dependencies installed: - - .. code-block:: text - - c:\pyramidtut> Scripts\easy_install pyramid - -#. Use ``easy_install`` to install ``docutils``, ``pyramid_tm``, - ``pyramid_zodbconn``, ``pyramid_debugtoolbar``, ``nose`` and ``coverage``: +#. Install tutorial dependencies: .. code-block:: text diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst index 05b6a2a42..572bffcab 100644 --- a/docs/tutorials/wiki2/installation.rst +++ b/docs/tutorials/wiki2/installation.rst @@ -2,30 +2,22 @@ Installation ============ -This tutorial assumes that Python and :term:`virtualenv` are already installed -and working in your system. If you need help setting this up, you should -refer to the chapters on :ref:`installing_chapter`. - Preparation =========== -Please take the following steps to prepare for the tutorial. The -steps are slightly different depending on whether you're using UNIX or -Windows. +Follow the steps in :ref:`installing_chapter`, but name the virtualenv +directory ``pyramidtut``. Preparation, UNIX ----------------- #. Install SQLite3 and its development packages if you don't already have them installed. Usually this is via your system's package - manager. For example, on a Debian Linux system, do ``sudo apt-get - install libsqlite3-dev``. - -#. Use your Python's virtualenv to make a workspace: + manager. On a Debian system, this would be: .. code-block:: text - $ path/to/my/Python-2.6/bin/virtualenv --no-site-packages pyramidtut + $ sudo apt-get install libsqlite3-dev #. Switch to the ``pyramidtut`` directory: @@ -33,35 +25,16 @@ Preparation, UNIX $ cd pyramidtut -#. Use ``easy_install`` to get :app:`Pyramid` and its direct - dependencies installed: - - .. code-block:: text - - $ bin/easy_install pyramid Preparation, Windows -------------------- -#. Use your Python's virtualenv to make a workspace: - - .. code-block:: text - - c:\> c:\Python26\Scripts\virtualenv --no-site-packages pyramidtut - #. Switch to the ``pyramidtut`` directory: .. code-block:: text c:\> cd pyramidtut -#. Use ``easy_install`` to get :app:`Pyramid` and its direct - dependencies installed: - - .. code-block:: text - - c:\pyramidtut> Scripts\easy_install pyramid - .. _sql_making_a_project: Making a Project -- cgit v1.2.3 From 7673b06209888e2837a135d0c51f6918b94cb70b Mon Sep 17 00:00:00 2001 From: "Lorenzo M. Catucci" Date: Fri, 4 Jan 2013 15:42:34 +0100 Subject: Fix pdf document generation by making sphinx aware about the images referenced in the latex preamble. --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index abb8bdd2e..3dc72d8ae 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -235,6 +235,8 @@ latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). latex_font_size = '10pt' +latex_additional_files = ['_static/latex-note.png', '_static/latex-warning.png'] + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ -- cgit v1.2.3